DataCache

interface DataCache

Types

inline suspend fun <T : Any> DataCache.count(block: QueryBuilder<T>.() -> Unit = {}): Long

Returns the amount of values that match the block.

inline fun <T : Any> DataCache.~~find~~(block: QueryBuilder<T>.() -> Unit = {}): Query<T>

Creates a new Query configured with the block.

inline fun <T : Any> DataCache.flow(block: QueryBuilder<T>.() -> Unit = {}): Flow<T>

Executes a query with the block and returns the values as a Flow.

Returns a DataEntryCache of the given type if its description was registered beforehand, null otherwise.

Returns a DataEntryCache of the given T if its description was registered beforehand, null otherwise.

inline suspend fun <T : Any> DataCache.put(item: T): Unit?

suspend fun <T : Any> DataCache.put(type: KType, item: T): Unit?

Inserts a new item into the cache. Inserting an entry with an id that is already present will cause the old value to be overwritten.

inline suspend fun <T : Any> DataCache.putAll(vararg items: T): <Error class: unknown class>?

inline suspend fun <T : Any> DataCache.putAll(items: Iterable<T>): <Error class: unknown class>?

inline suspend fun <T : Any> DataCache.putAll(items: Flow<T>): Unit?

Inserts all items into the cache. Inserting an entry with an id that is already present will cause the old value to be overwritten.

inline fun <T : Any> DataCache.query(block: QueryBuilder<T>.() -> Unit = {}): Query<T>

Creates a new Query configured with the block.

abstract suspend fun register(description: DataDescription<out Any, out Any>)

Registers a description and preforms the necessary setup to use the type of this class.

open suspend fun register(vararg descriptions: DataDescription<out Any, out Any>): <Error class: unknown class>

open suspend fun register(descriptions: Iterable<DataDescription<out Any, out Any>>): <Error class: unknown class>

Registers the descriptions and preforms the necessary setup to use the type of these classes.

inline suspend fun <T : Any> DataCache.remove(block: QueryBuilder<T>.() -> Unit = {})

Removes all the values that match the block.

Wraps this cache in a MetricsCache, enabling logging of metrics.