micro_utils.dokka/dev.inmo.micro_utils.repos.cache.cache/FullKVCache

FullKVCache

interface FullKVCache<K, V> : KVCache<K, V>

This interface declares that current type of KVCache will contains all the data all the time of its life

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
inline suspend fun <K, V> KVCache<K, V>.actualizeAll(repo: ReadCRUDRepo<V, K>, clear: Boolean = true)
inline suspend fun <K, V> KVCache<K, V>.actualizeAll(repo: ReadKeyValueRepo<K, V>, clear: Boolean = true)
inline suspend fun <K, V> KVCache<K, V>.actualizeAll(clear: Boolean = true, getAll: () -> Map<K, V>)
inline suspend fun <K, V> KVCache<K, List<V>>.actualizeAll(repo: ReadKeyValuesRepo<K, V>, clear: Boolean = true)
Link copied to clipboard
@JvmName(name = "asListKeyValuesRepo")
fun <K, V> KeyValueRepo<K, List<V>>.asKeyValuesRepo(): KeyValuesFromKeyValueRepo<K, V, List<V>>
@JvmName(name = "asSetKeyValuesRepo")
fun <K, V> KeyValueRepo<K, Set<V>>.asKeyValuesRepo(): KeyValuesFromKeyValueRepo<K, V, Set<V>>
fun <K, V, VI : Iterable<V>> KeyValueRepo<K, VI>.asKeyValuesRepo(listToValuesIterable: suspend (List<V>) -> VI): KeyValuesFromKeyValueRepo<K, V, VI>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>): ReadKeyValueCacheRepo<Key, Value>
fun <Key, Value> KeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): KeyValueCacheRepo<Key, Value>
fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: FullKVCache<Key, Value>): FullReadKeyValueCacheRepo<Key, Value>
Link copied to clipboard
fun <Key, Value> WriteKeyValueRepo<Key, Value>.caching(kvCache: FullKVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullWriteKeyValueCacheRepo<Key, Value>
Link copied to clipboard
open suspend fun clear()

By default, will remove all the data of current repo using doAllWithCurrentPaging, keys and unset

Link copied to clipboard
abstract suspend fun contains(key: K): Boolean
Link copied to clipboard
abstract suspend fun count(): Long
Link copied to clipboard
fun <Key, Value> KeyValueRepo<Key, Value>.fullyCached(kvCache: FullKVCache<Key, Value> = FullKVCache(), scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullKeyValueCacheRepo<Key, Value>
Link copied to clipboard
abstract suspend fun get(k: K): V?
Link copied to clipboard
open suspend fun getAll(): Map<K, V>
Link copied to clipboard
abstract suspend fun keys(pagination: Pagination, reversed: Boolean = false): PaginationResult<K>

This method should use sorted by Keys search and return the PaginationResult. By default, it should use ascending sort for Keys

open suspend fun keys(v: V, pagination: Pagination, reversed: Boolean = false): PaginationResult<K>

This method should use sorted by Keys search and return the PaginationResult. By default, it should use ascending sort for Keys.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun set(toSet: Map<K, V>)

Will set as batch toSet data in current repo. Must pass the data which were successfully updated in repo to onNewValue

Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(vararg toSet: Pair<Key, Value>)
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(toSet: List<Pair<Key, Value>>)
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(k: Key, v: Value)
Link copied to clipboard
abstract suspend fun unset(toUnset: List<K>)

Will unset as batch data with keys from toUnset. Must pass the Keys which were successfully removed in repo to onValueRemoved

Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unset(vararg k: Key)
Link copied to clipboard
open suspend override fun unsetWithValues(toUnset: List<V>)

By default, will walk throw all the keys with Values from toUnset and run doAllWithCurrentPaging with unset of found data Keys

Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unsetWithValues(vararg v: Value)
Link copied to clipboard
abstract suspend fun values(pagination: Pagination, reversed: Boolean = false): PaginationResult<V>

This method should use sorted by Keys search and return the PaginationResult. By default, it should use ascending sort for Keys

Link copied to clipboard
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): KeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): ReadKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): WriteKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): KeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): ReadKeyValueRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValueRepo<ToKey, ToValue>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }): WriteKeyValueRepo<FromKey, FromValue>

Properties

Link copied to clipboard
abstract val onNewValue: Flow<Pair<K, V>>

This flow must emit data each time when data by Key has been changed with set method or in any other way excluding cases of data removing

Link copied to clipboard
abstract val onValueRemoved: Flow<K>

This flow must emit data each time when data by Key has been removed with unset/unsetWithValues methods or in any other way