micro_utils.dokka/dev.inmo.micro_utils.repos/WriteKeyValueRepo

WriteKeyValueRepo

interface WriteKeyValueRepo<Key, Value> : Repo

Write part of KeyValueRepo

Parameters

Key

This type will be used as key in all operations related to changes of data

Value

This type will be used as incoming data in most operations

Functions

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

abstract suspend fun unsetWithValues(toUnset: List<Value>)

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

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

KeyValueRepo

DelegateBasedKeyValueRepo

WriteMapKeyValueRepo

MapKeyValueRepo

KeyValueCacheRepo

FullWriteKeyValueCacheRepo

MapperWriteKeyValueRepo

MapperKeyValueRepo

KtorWriteKeyValueRepoClient

FileWriteKeyValueRepo

FileKeyValueRepo

Extensions

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> 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>