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

WriteKeyValueRepo

interface WriteKeyValueRepo<Key, Value> : Repo(source)

Write part of KeyValueRepo

Type 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

Inheritors

KeyValueRepo

DelegateBasedKeyValueRepo

WriteMapKeyValueRepo

MapKeyValueRepo

KeyValueCacheRepo

AutoRecacheKeyValueRepo

AutoRecacheWriteKeyValueRepo

FullWriteKeyValueCacheRepo

FullKeyValueCacheRepo

DirectFullWriteKeyValueCacheRepo

DirectFullKeyValueCacheRepo

MapperWriteKeyValueRepo

MapperKeyValueRepo

KtorWriteKeyValueRepoClient

FileWriteKeyValueRepo

FileKeyValueRepo

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

Functions

caching

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

directlyCached

fun <Key, Value> WriteKeyValueRepo<Key, Value>.directlyCached(kvCache: KeyValueRepo<Key, Value>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): DirectFullWriteKeyValueCacheRepo<Key, Value>

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

set

inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(toSet: List<Pair<Key, Value>>)

List overload of WriteKeyValueRepo.set accepting a list of pairs.

inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(vararg toSet: Pair<Key, Value>)

Vararg overload of WriteKeyValueRepo.set accepting pairs.

inline suspend fun <Key, Value> WriteKeyValueRepo<Key, Value>.set(k: Key, v: Value)

Single-entry overload of WriteKeyValueRepo.set.

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

unset

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

Vararg overload of WriteKeyValueRepo.unset.

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

unsetWithValues

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

Vararg overload of WriteKeyValueRepo.unsetWithValues.

withMapper

inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValueRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): WriteKeyValueRepo<FromKey, FromValue>

Wraps this WriteKeyValueRepo with a MapperRepo to expose a mapped WriteKeyValueRepo.

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>

Wraps this WriteKeyValueRepo with inline conversion lambdas to expose a mapped WriteKeyValueRepo.