micro_utils.dokka/dev.inmo.micro_utils.repos.transforms.kv/KeyValueFromKeyValuesRepo

KeyValueFromKeyValuesRepo

open class KeyValueFromKeyValuesRepo<Key, Value>(original: KeyValuesRepo<Key, Value>) : KeyValueRepo<Key, List<Value>> , ReadKeyValueFromKeyValuesRepo<Key, Value> (source)

Full read-write adapter that exposes a KeyValuesRepo as a KeyValueRepo mapping each key to a List of values. Extends ReadKeyValueFromKeyValuesRepo with write operations delegated to the underlying KeyValuesRepo. onNewValue merges KeyValuesRepo.onNewValue and KeyValuesRepo.onValueRemoved and emits the updated list per key; onValueRemoved mirrors KeyValuesRepo.onDataCleared.

Parameters

original

The underlying KeyValuesRepo to delegate operations to

Type Parameters

Key

The type of keys

Value

The type of individual values in the one-to-many repo

Constructors

KeyValueFromKeyValuesRepo

constructor(original: KeyValuesRepo<Key, Value>)

Properties

onNewValue

open override val onNewValue: Flow<Pair<Key, List<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

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

actualizeAll

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAll(locker: SmartRWLocker? = null, clearMode: ActualizeAllClearMode = ActualizeAllClearMode.BeforeSet, getAll: () -> Map<K, V>)

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAll(parentRepo: ReadCRUDRepo<V, K>, locker: SmartRWLocker? = null, clearMode: ActualizeAllClearMode = ActualizeAllClearMode.BeforeSet)

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAll(parentRepo: ReadKeyValueRepo<K, V>, locker: SmartRWLocker? = null, clearMode: ActualizeAllClearMode = ActualizeAllClearMode.BeforeSet)

inline suspend fun <K, V> KeyValueRepo<K, List<V>>.actualizeAll(parentRepo: ReadKeyValuesRepo<K, V>, locker: SmartRWLocker? = null, clearMode: ActualizeAllClearMode = ActualizeAllClearMode.BeforeSet)

actualizeAllWithClearBeforeLoad

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeLoad(getAll: () -> Map<K, V>)

@JvmName(name = "actualizeAllWithClearBeforeLoadWithLocker")

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeLoad(locker: SmartRWLocker, getAll: () -> Map<K, V>)

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeLoad(locker: SmartRWLocker? = null, getAll: () -> Map<K, V>)

actualizeAllWithClearBeforeSet

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeSet(getAll: () -> Map<K, V>)

@JvmName(name = "actualizeAllWithClearBeforeSetWithLocker")

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeSet(locker: SmartRWLocker, getAll: () -> Map<K, V>)

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithClearBeforeSet(locker: SmartRWLocker? = null, getAll: () -> Map<K, V>)

actualizeAllWithoutClear

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithoutClear(getAll: () -> Map<K, V>)

@JvmName(name = "actualizeAllWithoutClearWithLocker")

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithoutClear(locker: SmartRWLocker, getAll: () -> Map<K, V>)

inline suspend fun <K, V> KeyValueRepo<K, V>.actualizeAllWithoutClear(locker: SmartRWLocker? = null, getAll: () -> Map<K, V>)

applyDiff

suspend fun <Id, Registered> KeyValueRepo<Id, Registered>.applyDiff(diff: MapDiff<Id, Registered>)

Applies the given diff to this KeyValueRepo: removes entries in MapDiff.removed, updates entries in MapDiff.changed, and adds entries in MapDiff.added.

suspend fun <Id, Registered> KeyValueRepo<Id, Registered>.applyDiff(other: Map<Id, Registered>)

Computes the diff between this KeyValueRepo and other, then applies the diff to this repo.

asKeyValuesRepo

@JvmName(name = "asListKeyValuesRepo")

fun <K, V> KeyValueRepo<K, List<V>>.asKeyValuesRepo(): KeyValuesFromKeyValueRepo<K, V, List<V>>

Wraps this KeyValueRepo (mapping keys to Lists) as a KeyValuesFromKeyValueRepo. Uses identity conversion for the list iterable.

@JvmName(name = "asSetKeyValuesRepo")

fun <K, V> KeyValueRepo<K, Set<V>>.asKeyValuesRepo(): KeyValuesFromKeyValueRepo<K, V, Set<V>>

Wraps this KeyValueRepo (mapping keys to Sets) as a KeyValuesFromKeyValueRepo. Converts lists to sets when persisting changes, ensuring value uniqueness per key.

fun <K, V, VI : Iterable<V>> KeyValueRepo<K, VI>.asKeyValuesRepo(listToValuesIterable: suspend (List<V>) -> VI): KeyValuesFromKeyValueRepo<K, V, VI>

Wraps this KeyValueRepo (mapping keys to iterables) as a KeyValuesFromKeyValueRepo, exposing a full one-to-many read-write interface.

asReadCRUDRepo

fun <K, V> ReadKeyValueRepo<K, V>.asReadCRUDRepo(): ReadCRUDFromKeyValueRepo<V, K>

Wraps this ReadKeyValueRepo as a ReadCRUDFromKeyValueRepo, exposing CRUD read operations.

asReadKeyValuesRepo

fun <K, V, VI : Iterable<V>> ReadKeyValueRepo<K, VI>.asReadKeyValuesRepo(): ReadKeyValuesFromKeyValueRepo<K, V, VI>

Wraps this ReadKeyValueRepo (mapping keys to iterables) as a ReadKeyValuesFromKeyValueRepo, exposing a one-to-many read interface.

cached

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

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

fun <Key, Value> ReadKeyValueRepo<Key, Value>.cached(kvCache: KeyValueRepo<Key, Value>, locker: SmartRWLocker = SmartRWLocker()): FullReadKeyValueCacheRepo<Key, Value>

caching

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

clear

open suspend fun clear()

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

contains

open suspend fun contains(key: Key): Boolean

count

open suspend fun count(): Long

diff

suspend fun <Id, Registered> ReadKeyValueRepo<Id, Registered>.diff(other: Map<Id, Registered>): MapDiff<Id, Registered>

Computes the difference between all entries in this ReadKeyValueRepo and the given other map.

directlyCached

fun <Key, Value> ReadKeyValueRepo<Key, Value>.directlyCached(kvCache: KeyValueRepo<Key, Value>, locker: SmartRWLocker = SmartRWLocker()): DirectFullReadKeyValueCacheRepo<Key, Value>

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

directlyFullyCached

fun <Key, Value> KeyValueRepo<Key, Value>.directlyFullyCached(kvCache: KeyValueRepo<Key, Value> = MapKeyValueRepo(), scope: CoroutineScope = CoroutineScope(Dispatchers.Default), skipStartInvalidate: Boolean = false, locker: SmartRWLocker = SmartRWLocker()): DirectFullKeyValueCacheRepo<Key, Value>

fullyCached

fun <Key, Value> KeyValueRepo<Key, Value>.fullyCached(kvCache: KeyValueRepo<Key, Value> = MapKeyValueRepo(), scope: CoroutineScope = CoroutineScope(Dispatchers.Default), skipStartInvalidate: Boolean = false, locker: SmartRWLocker = SmartRWLocker()): FullKeyValueCacheRepo<Key, Value>

get

open suspend fun get(k: Key): List<Value>?

getAll

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

Returns all key-value pairs in the repository as a Map. Default implementation iterates all pages using keys and get.

keys

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

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: List<Value>, pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>

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

maxPagePagination

inline suspend fun ReadKeyValueRepo<*, *>.maxPagePagination(): SimplePagination

Creates a pagination starting from the first page with size equal to the total count of items in this ReadKeyValueRepo. This effectively creates a single page containing all items.

set

open suspend override fun set(toSet: Map<Key, List<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

open suspend override 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

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

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

unsetWithValues

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

Vararg overload of WriteKeyValueRepo.unsetWithValues.

values

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

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

withMapper

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

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

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

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

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

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

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>

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

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.