kvs-core/com.santimattius.kvs/Kvs

Kvs

interface Kvs : KvsStandard, KvsStream

Core key-value storage interface.

Kvs is the primary contract for reading and writing typed key-value pairs. All read operations are suspending and safe to call from any coroutine context. Writes are batched through KvsEditor and flushed atomically via KvsEditor.commit.

Implementations are provided by the artifact-specific factory functions on Storage (e.g. Storage.inMemoryKvs, Storage.kvsLight, Storage.kvsOptimized).

See also

Types

interface KvsEditor

Builder for applying a batch of write operations to the store.

Functions

abstract suspend operator fun contains(key: String): Boolean

Returns true if an entry with the given key exists in the store.

abstract fun edit(): Kvs.KvsEditor

Returns a new KvsEditor for staging write operations.

abstract suspend fun getAll(): Map<String, Any>

Returns all key-value entries currently held in the store.

@HiddenFromObjC

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

abstract fun getAllAsStream(): Flow<Map<String, Any>>

Returns a Flow that emits the full store snapshot on every change.

abstract suspend fun getBoolean(key: String, defValue: Boolean): Boolean

Reads the Boolean value stored under key, returning defValue if absent.

getBooleanAsResult

@HiddenFromObjC

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

getBooleanAsStream

abstract fun getBooleanAsStream(key: String, defValue: Boolean): Flow<Boolean>

Returns a Flow of the Boolean value stored under key.

abstract suspend fun getFloat(key: String, defValue: Float): Float

Reads the Float value stored under key, returning defValue if absent.

getFloatAsResult

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

getFloatAsStream

abstract fun getFloatAsStream(key: String, defValue: Float): Flow<Float>

Returns a Flow of the Float value stored under key.

abstract suspend fun getInt(key: String, defValue: Int): Int

Reads the Int value stored under key, returning defValue if absent.

@HiddenFromObjC

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

abstract fun getIntAsStream(key: String, defValue: Int): Flow<Int>

Returns a Flow of the Int value stored under key.

abstract suspend fun getLong(key: String, defValue: Long): Long

Reads the Long value stored under key, returning defValue if absent.

getLongAsResult

@HiddenFromObjC

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

getLongAsStream

abstract fun getLongAsStream(key: String, defValue: Long): Flow<Long>

Returns a Flow of the Long value stored under key.

abstract suspend fun getString(key: String, defValue: String): String

Reads the String value stored under key, returning defValue if absent.

getStringAsResult

@HiddenFromObjC

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

getStringAsStream

abstract fun getStringAsStream(key: String, defValue: String): Flow<String>

Returns a Flow of the String value stored under key.