micro_utils.dokka/dev.inmo.micro_utils.repos/ReadMapKeyValueRepo

ReadMapKeyValueRepo

class ReadMapKeyValueRepo<Key, Value>(map: Map<Key, Value>, locker: SmartRWLocker) : ReadKeyValueRepo<Key, Value> (source)

Map-based ReadKeyValueRepo. 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

ReadMapKeyValueRepo

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

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

Functions

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> ReadKeyValueRepo<Key, Value>.cached(kvCache: KeyValueRepo<Key, Value>, locker: SmartRWLocker = SmartRWLocker()): FullReadKeyValueCacheRepo<Key, Value>

contains

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

count

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

get

open suspend override fun get(k: Key): Value?

getAll

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

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

keys

open suspend override 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 override fun keys(v: 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.

values

open suspend override fun values(pagination: Pagination, reversed: Boolean = false): PaginationResult<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> 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> 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.