api/dev.kord.cache.api.meta/MetricsCache

MetricsCache

class MetricsCache(delegate: DataCache, logger: StatisticsLogger = StatisticsLogger()) : DataCache

A DataCache that logs usage statistics via its logger.

Constructors

MetricsCache

constructor(delegate: DataCache, logger: StatisticsLogger = StatisticsLogger())

Properties

statistics

val statistics: CacheStatistics

Functions

count

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

Returns the amount of values that match the block.

find

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

Creates a new Query configured with the block.

flow

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.

getEntry

open override fun <T : Any> getEntry(type: KType): DataEntryCache<T>?

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

getEntry

inline fun <T : Any> DataCache.getEntry(): DataEntryCache<T>?

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

put

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.

putAll

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

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

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.

query

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

Creates a new Query configured with the block.

open suspend override 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 override fun register(vararg descriptions: DataDescription<out Any, out Any>)

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

open suspend override fun register(descriptions: Iterable<DataDescription<out Any, out Any>>)

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

remove

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

Removes all the values that match the block.

withMetrics

fun DataCache.withMetrics(): MetricsCache

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