coil-core/coil3.disk/DiskCache

DiskCache

interface DiskCache

An LRU cache of files.

Types

interface Editor

Edits the values for an entry.

interface Snapshot : AutoCloseable

A snapshot of the values for an entry.

Properties

abstract val directory: Path

The directory that contains the cache's files.

abstract val fileSystem: FileSystem

The file system that contains the cache's files.

abstract val maxSize: Long

The maximum size of the cache in bytes.

abstract val size: Long

The current size of the cache in bytes.

Functions

abstract fun clear()

Delete all entries in the disk cache.

abstract fun openEditor(key: String): DiskCache.Editor?

Write to the entry associated with key.

abstract fun openSnapshot(key: String): DiskCache.Snapshot?

Read the entry associated with key.

abstract fun remove(key: String): Boolean

Delete the entry referenced by key.

abstract fun shutdown()

Close any open snapshots, abort all in-progress edits, and close any open system resources.