kvs-core/com.santimattius.kvs

Package-level declarations

Types

Contract for a single serialized document stored as a raw String.

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This is an experimental KVS TTL API. It may change in future releases.")

annotation class ExperimentalKvsTtl

GetAllKvsException

class GetAllKvsException(message: String) : KvsException

InternalKvsApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal KVS API not intended for external use. It may change or be removed without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class InternalKvsApi

Internal API — not stable for external use. Subject to change without notice.

Kvs

interface Kvs : KvsStandard, KvsStream

Core key-value storage interface.

KvsException

abstract class KvsException(message: String, cause: Throwable? = null) : Throwable

KvsExtended

interface KvsExtended : KvsStandard, KvsStream

Extended key-value storage interface with Time-To-Live (TTL) support.

ReadKvsException

class ReadKvsException(message: String, cause: Throwable? = null) : KvsException

Storage

object Storage

Entry point for all Key-Value Storage instances.

WriteKvsException

class WriteKvsException(message: String, cause: Throwable? = null) : KvsException

Functions

apply

@HiddenFromObjC

suspend fun Kvs.KvsEditor.apply(): Result<Boolean>

getAllAsResult

@HiddenFromObjC

suspend fun Kvs.getAllAsResult(): Result<Map<String, Any>>

getBooleanAsResult

@HiddenFromObjC

suspend fun Kvs.getBooleanAsResult(key: String, defValue: Boolean): Result<Boolean>

getFloatAsResult

suspend fun Kvs.getFloatAsResult(key: String, defValue: Float): Result<Float>

getIntAsResult

@HiddenFromObjC

suspend fun Kvs.getIntAsResult(key: String, defValue: Int): Result<Int>

getLongAsResult

@HiddenFromObjC

suspend fun Kvs.getLongAsResult(key: String, defValue: Long): Result<Long>

getStringAsResult

@HiddenFromObjC

suspend fun Kvs.getStringAsResult(key: String, defValue: String): Result<String>