micro_utils.dokka
0.15.1

# KeyValuesRepo

interface KeyValuesRepo<Key, Value> : ReadKeyValuesRepo<Key, Value> , WriteKeyValuesRepo<Key, Value>

## Functions

add
Link copied to clipboard
abstract suspend fun add(toAdd: Map<Key, List<Value>>)
clear
Link copied to clipboard
abstract suspend fun clear(k: Key)
clearWithValue
Link copied to clipboard
open suspend override fun clearWithValue(v: Value)
contains
Link copied to clipboard
abstract suspend fun contains(k: Key): Boolean
abstract suspend fun contains(k: Key, v: Value): Boolean
count
Link copied to clipboard
abstract suspend fun count(): Long
abstract suspend fun count(k: Key): Long
get
Link copied to clipboard
abstract suspend fun get(k: Key, pagination: Pagination, reversed: Boolean = false): PaginationResult<Value>
getAll
Link copied to clipboard
open suspend fun getAll(reverseLists: Boolean = false): Map<Key, List<Value>>

WARNING!!! THIS METHOD PROBABLY IS NOT EFFICIENT, USE WITH CAUTION

open suspend fun getAll(k: Key, reversed: Boolean = false): List<Value>
keys
Link copied to clipboard
abstract suspend fun keys(pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>
abstract suspend fun keys(v: Value, pagination: Pagination, reversed: Boolean = false): PaginationResult<Key>
remove
Link copied to clipboard
abstract suspend fun remove(toRemove: Map<Key, List<Value>>)
set
Link copied to clipboard
open suspend fun set(toSet: Map<Key, List<Value>>)

## Properties

onDataCleared
Link copied to clipboard
abstract val onDataCleared: Flow<Key>
onNewValue
Link copied to clipboard
abstract val onNewValue: Flow<Pair<Key, Value>>
onValueRemoved
Link copied to clipboard
abstract val onValueRemoved: Flow<Pair<Key, Value>>

## Inheritors

OneToManyAndroidRepo
Link copied to clipboard
DelegateBasedKeyValuesRepo
Link copied to clipboard
MapKeyValuesRepo
Link copied to clipboard
KeyValuesCacheRepo
Link copied to clipboard
FullKeyValuesCacheRepo
Link copied to clipboard
MapperKeyValuesRepo
Link copied to clipboard
KtorKeyValuesRepoClient
Link copied to clipboard
AbstractExposedKeyValuesRepo
Link copied to clipboard
ExposedKeyValuesRepo
Link copied to clipboard

## Extensions

add
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, v: List<Value>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.add(k: Key, vararg v: Value)
cached
Link copied to clipboard
fun <Key, Value> KeyValuesRepo<Key, Value>.cached(kvCache: KVCache<Key, List<Value>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): KeyValuesCacheRepo<Key, Value>
fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: KVCache<Key, List<Value>>): ReadKeyValuesCacheRepo<Key, Value>
fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: FullKVCache<Key, List<Value>>): FullReadKeyValuesCacheRepo<Key, Value>
caching
Link copied to clipboard
fun <Key, Value> KeyValuesRepo<Key, Value>.caching(kvCache: FullKVCache<Key, List<Value>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullKeyValuesCacheRepo<Key, Value>
fun <Key, Value> WriteKeyValuesRepo<Key, Value>.caching(kvCache: FullKVCache<Key, List<Value>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): FullWriteKeyValuesCacheRepo<Key, Value>
remove
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(keysAndValues: List<Pair<Key, List<Value>>>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(vararg keysAndValues: Pair<Key, List<Value>>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, v: List<Value>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.remove(k: Key, vararg v: Value)
set
Link copied to clipboard
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.set(k: Key, v: List<Value>)
inline suspend fun <Key, Value> WriteKeyValuesRepo<Key, Value>.set(k: Key, vararg v: Value)
withMapper
Link copied to clipboard
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValuesRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): KeyValuesRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> KeyValuesRepo<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 }): KeyValuesRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValuesRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): ReadKeyValuesRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> ReadKeyValuesRepo<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 }): ReadKeyValuesRepo<FromKey, FromValue>
inline fun <FromKey, FromValue, ToKey, ToValue> WriteKeyValuesRepo<ToKey, ToValue>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>): WriteKeyValuesRepo<FromKey, FromValue>
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>