micro_utils.dokka/dev.inmo.micro_utils.repos/MapReadKeyValuesRepo

MapReadKeyValuesRepo

class MapReadKeyValuesRepo<Key, Value>(map: Map<Key, List<Value>> = emptyMap(), locker: SmartRWLocker = SmartRWLocker()) : ReadKeyValuesRepo<Key, Value> (source)

Map-based ReadKeyValuesRepo. All internal operations will be locked with locker (mostly with SmartRWLocker.withReadAcquire)

Warning: It is not recommended to use constructor with both Map and SmartRWLocker. Besides, in case you are using your own Map as a map you should be careful with operations on this map

Constructors

constructor(map: Map<Key, List<Value>> = emptyMap(), locker: SmartRWLocker = SmartRWLocker())

Functions

asReadKeyValueRepo

fun <K, V> ReadKeyValuesRepo<K, V>.asReadKeyValueRepo(): ReadKeyValueFromKeyValuesRepo<K, V>

Wraps this ReadKeyValuesRepo as a ReadKeyValueFromKeyValuesRepo, exposing each key mapped to a List of all associated values.

cached

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: KVCache<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): ReadKeyValuesCacheRepo<Key, Value>

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.cached(kvCache: KeyValueRepo<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): FullReadKeyValuesCacheRepo<Key, Value>

contains

open suspend override fun contains(k: Key): Boolean

Checks if the specified key exists in the repository.

open suspend override fun contains(k: Key, v: Value): Boolean

Checks if the specified key-value pair exists in the repository.

count

open suspend override fun count(): Long

Returns the total count of key-value pairs in the repository.

open suspend override fun count(k: Key): Long

Returns the count of values associated with the specified key.

diff

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

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

directlyCached

fun <Key, Value> ReadKeyValuesRepo<Key, Value>.directlyCached(kvCache: KeyValueRepo<Key, List<Value>>, locker: SmartRWLocker = SmartRWLocker()): DirectFullReadKeyValuesCacheRepo<Key, Value>

get

open suspend override fun get(k: Key, pagination: Pagination, reversed: Boolean = false): PaginationResult<Value>

Retrieves a paginated list of values associated with the given key.

getAll

open suspend override fun getAll(reverseLists: Boolean = false): Map<Key, List<Value>>

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

open suspend override fun getAll(k: Key, reversed: Boolean = false): List<Value>

keys

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

Retrieves a paginated list of keys.

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

Retrieves keys that have the specified value associated with them.

maxPagePagination

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

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

withMapper

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

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

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>

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