datastore-preferences/com.episode6.typed2.datastore.preferences

Package-level declarations

Types

DataStoreKey

typealias DataStoreKey<T, BACKED_BY> = AsyncKey<T, BACKED_BY, DataStoreValueGetter, DataStoreValueSetter>

DataStoreKeyBuilder

interface DataStoreKeyBuilder : PrimitiveKeyBuilder

DataStoreKeyNamespace

open class DataStoreKeyNamespace(prefix: String = "")

DataStoreValue

sealed interface DataStoreValue<out T>

Wrapper for values emitted by mutableStateFlow. Because DataStore can only be read asynchronously, these state flows can't be initialized with a real value; Uninitialized distinguishes that startup state from a genuine read of an absent key (which emits Loaded with a null value).

DataStoreValueGetter

interface DataStoreValueGetter : PrimitiveKeyValueGetter

DataStoreValueSetter

interface DataStoreValueSetter : PrimitiveKeyValueSetter

TypedMutablePreferences

class TypedMutablePreferences(mutablePrefs: MutablePreferences) : TypedPreferences, DataStoreValueSetter

TypedPreferences

open class TypedPreferences(prefs: Preferences) : DataStoreValueGetter

Properties

valueOrNull

val <T> DataStoreValue<T>.valueOrNull: T?

Functions

boolean

fun DataStoreKeyBuilder.boolean(): DataStoreKey<Boolean?, String?>

fun DataStoreKeyBuilder.boolean(default: Boolean): DataStoreKey<Boolean, Boolean>

double

fun DataStoreKeyBuilder.double(): DataStoreKey<Double?, String?>

fun DataStoreKeyBuilder.double(default: Double): DataStoreKey<Double, String?>

edit

suspend fun DataStore<Preferences>.edit(action: suspend TypedMutablePreferences.() -> Unit): TypedPreferences

float

fun DataStoreKeyBuilder.float(): DataStoreKey<Float?, String?>

fun DataStoreKeyBuilder.float(default: Float): DataStoreKey<Float, Float>

flow

fun <T> DataStore<Preferences>.flow(key: DataStoreKey<T, *>): Flow<T>

get

suspend fun <T> DataStore<Preferences>.get(key: DataStoreKey<T, *>): T

suspend fun <T> DataStoreValueGetter.get(key: DataStoreKey<T, *>): T

int

fun DataStoreKeyBuilder.int(): DataStoreKey<Int?, String?>

fun DataStoreKeyBuilder.int(default: Int): DataStoreKey<Int, Int>

launchEdit

fun DataStore<Preferences>.launchEdit(scope: CoroutineScope, action: suspend TypedMutablePreferences.() -> Unit): Job

long

fun DataStoreKeyBuilder.long(): DataStoreKey<Long?, String?>

fun DataStoreKeyBuilder.long(default: Long): DataStoreKey<Long, Long>

mutableStateFlow

fun <T> DataStore<Preferences>.mutableStateFlow(key: DataStoreKey<T, *>, scope: CoroutineScope, debounceWrites: Duration = Duration.ZERO): MutableStateFlow<DataStoreValue<T>>

Returns a MutableStateFlow that starts as DataStoreValue.Uninitialized, reflects the latest value of key as DataStoreValue.Loaded emissions, and persists any DataStoreValue.Loaded values set on it (a loaded null value removes the entry; setting DataStoreValue.Uninitialized is a no-op on the store).

property

fun <T> DataStore<Preferences>.property(key: DataStoreKey<T, *>, scope: CoroutineScope): DelegateProperty<T?>

Returns a nullable property delegate backed by mutableStateFlow; it reads null until the first value is loaded from the store, and setting null removes the entry.

remove

suspend fun DataStore<Preferences>.remove(key: DataStoreKey<*, *>)

fun DataStoreValueSetter.remove(key: DataStoreKey<*, *>)

set

suspend fun <T> DataStore<Preferences>.set(key: DataStoreKey<T, *>, value: T)

suspend fun <T> DataStoreValueSetter.set(key: DataStoreKey<T, *>, value: T)

string

fun DataStoreKeyBuilder.string(): DataStoreKey<String?, String?>

fun DataStoreKeyBuilder.string(default: String): DataStoreKey<String, String>

stringSet

fun DataStoreKeyBuilder.stringSet(): DataStoreKey<Set<String>?, Set<String?>?>

fun DataStoreKeyBuilder.stringSet(default: Set<String>): DataStoreKey<Set<String>, Set<String?>?>

typed

fun MutablePreferences.typed(): TypedMutablePreferences

fun Preferences.typed(): TypedPreferences

update

suspend fun <T> DataStore<Preferences>.update(key: DataStoreKey<T, *>, reducer: suspend (T) -> T)