micro_utils.dokka/dev.inmo.micro_utils.repos/WriteKeyValuesRepo

WriteKeyValuesRepo

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

Write part of KeyValuesRepo for one-to-many key-value relationships. Provides methods for adding, removing, and clearing values associated with keys.

Type Parameters

Key

The type used as the key in all write operations

Value

The type of values associated with keys

Inheritors

KeyValuesRepo

DelegateBasedKeyValuesRepo

MapWriteKeyValuesRepo

MapKeyValuesRepo

KeyValuesCacheRepo

AutoRecacheKeyValuesRepo

AutoRecacheWriteKeyValuesRepo

FullWriteKeyValuesCacheRepo

FullKeyValuesCacheRepo

DirectFullWriteKeyValuesCacheRepo

DirectFullKeyValuesCacheRepo

MapperWriteKeyValuesRepo

MapperKeyValuesRepo

KtorWriteKeyValuesRepoClient

Properties

onDataCleared

abstract val onDataCleared: Flow<Key>

Flow that emits when all data for a key is cleared.

onNewValue

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

Flow that emits when a new value is added to a key.

onValueRemoved

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

Flow that emits when a value is removed from a key.

Functions

add

abstract suspend fun add(toAdd: Map<Key, List<Value>>)

Adds values to the specified keys.

add

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, v: List<Value>)

Single-key overload of WriteKeyValuesRepo.add accepting a list of values.

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, vararg v: Value)

Single-key vararg overload of WriteKeyValuesRepo.add.

caching

fun <Key, Value> WriteKeyValuesRepo<Key, Value>.caching(kvCache: KeyValueRepo<Key, List<Value>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default), locker: SmartRWLocker = SmartRWLocker()): FullWriteKeyValuesCacheRepo<Key, Value>

clear

abstract suspend fun clear(k: Key)

Fully clears all data associated with the specified key.

clearWithValue

abstract suspend fun clearWithValue(v: Value)

Clears a specific value from all keys and removes those keys if they become empty.

directlyCached

fun <Key, Value> WriteKeyValuesRepo<Key, Value>.directlyCached(kvCache: KeyValueRepo<Key, List<Value>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default), locker: SmartRWLocker = SmartRWLocker()): DirectFullWriteKeyValuesCacheRepo<Key, Value>

remove

abstract suspend fun remove(toRemove: Map<Key, List<Value>>)

Removes specific values from keys without clearing all data for those keys.

remove

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(keysAndValues: List<Pair<Key, List<Value>>>)

List-of-pairs overload of WriteKeyValuesRepo.remove.

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(vararg keysAndValues: Pair<Key, List<Value>>)

Vararg overload of WriteKeyValuesRepo.remove.

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, v: List<Value>)

Single-key overload of WriteKeyValuesRepo.remove accepting a list of values.

inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, vararg v: Value)

Single-key vararg overload of WriteKeyValuesRepo.remove.

removeWithValue

abstract suspend fun removeWithValue(v: Value)

Removes a specific value from all keys that contain it, without clearing all data for those keys.

set

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

Sets the values for specified keys, clearing any existing values first.

set

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

Single-key overload of WriteKeyValuesRepo.set accepting a list of values.

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

Single-key vararg overload of WriteKeyValuesRepo.set.

withMapper

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

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

inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValuesRepo<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 }): WriteKeyValuesRepo<FromKey, FromValue>

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