micro_utils.dokka/dev.inmo.micro_utils.repos/KeyValueRepo

KeyValueRepo

interface KeyValueRepo<Key, Value> : ReadKeyValueRepo<Key, Value> , WriteKeyValueRepo<Key, Value>

Full version of standard key-value repository with all set/unset/clear/get methods

Functions

clear

open suspend fun clear()

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

contains

abstract suspend fun contains(key: Key): Boolean

count

abstract suspend fun count(): Long

get

abstract suspend fun get(k: Key): Value?

keys

abstract suspend fun keys(pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

abstract suspend fun keys(v: Value, pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

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

set

abstract suspend fun set(toSet: Map<Key, Value>)

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

unset

abstract suspend fun unset(toUnset: List<Key>)

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

unsetWithValues

open suspend override fun unsetWithValues(toUnset: List<Value>)

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

values

abstract suspend fun values(pagination: Pagination, reversed: Boolean = false): PaginationResult<Value>

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

Properties

onNewValue

abstract val onNewValue: Flow<Pair<Key, Value>>

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

onValueRemoved

abstract val onValueRemoved: Flow<Key>

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

Inheritors

KeyValueStore

DelegateBasedKeyValueRepo

FullKeyValueCacheRepo

MapperKeyValueRepo

KtorKeyValueRepoClient

FileKeyValueRepo

AbstractExposedKeyValueRepo

ExposedKeyValueRepo

Extensions

cached

fun <Key, Value> KeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): KeyValueCacheRepo<Key, Value>

fun <Key, Value> KeyValueRepo<Key, Value>.cached(kvCache: FullKVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullKeyValueCacheRepo<Key, Value>

fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: KVCache<Key, Value>): ReadKeyValueCacheRepo<Key, Value>

fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: FullKVCache<Key, Value>): FullReadKeyValueCacheRepo<Key, Value>

caching

fun <Key, Value> WriteKeyValueRepo<Key, Value>.caching(kvCache: FullKVCache<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullWriteKeyValueCacheRepo<Key, Value>

set

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)

unset

inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unset(vararg k: Key)

unsetWithValues

inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.unsetWithValues(vararg v: Value)

withMapper

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> 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(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): ReadKeyValueRepo<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(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): WriteKeyValueRepo<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>