FileKache

A persistent coroutine-safe ContainerKache implementation that uses Okio to store files under the hood and exposes a simple path-based API.

It uses a journal file to keep track of the cache state and to ensure that the cache is always in a consistent state.

It can be built using the following syntax:

val cache = OkioFileKache(directoryPath = "cache", maxSize = 100L * 1024L * 1024L) {
    strategy = KacheStrategy.LRU
    // ...
}

Types

class Configuration(var directoryPath: String, var maxSize: Long)

Configuration for FileKache. It is used as a receiver of FileKache builder which is invoke.

open override val maxSize: Long

open override val size: Long

open suspend override fun clear()

open suspend override fun close()

open suspend override fun get(key: String): String?

open suspend override fun getAllKeys(): KacheKeys<String>

open suspend override fun getIfAvailable(key: String): String?

open suspend override fun getKeys(): Set<String>

open suspend override fun getOrPut(key: String, creationFunction: suspend (String) -> Boolean): String?

open suspend override fun getUnderCreationKeys(): Set<String>

open suspend override fun put(key: String, creationFunction: suspend (String) -> Boolean): String?

open suspend override fun putAsync(key: String, creationFunction: suspend (String) -> Boolean): Deferred<String?>

open suspend override fun remove(key: String)

open suspend override fun removeAllUnderCreation()

open suspend override fun resize(maxSize: Long)

open suspend override fun trimToSize(size: Long)