MutablePreferences

open fun asMap(): Map<Preferences.Key<*>, Any>

Retrieve a map of all key preference pairs. The returned map is unmodifiable, and attempts to mutate it will throw runtime exceptions.

fun clear(): Unit

open operator fun <T : Any?> contains(key: Preferences.Key<T>): Boolean

Returns true if this Preferences contains the specified key.

open operator fun equals(other: Any?): Boolean

open operator fun <T : Any?> get(key: Preferences.Key<T>): T?

Get a preference with a key. If the key is not set, returns null.

If T is Set, this returns an unmodifiable set which will throw a runtime exception when mutated. Do not try to mutate the returned set.

Use MutablePreferences.set to change the value of a preference (inside a DataStore.edit block).

open fun hashCode(): Int

operator fun minusAssign(key: Preferences.Key<*>): Unit

Removes the preference with the given key from this MutablePreferences. If this Preferences does not contain the key, this is a no-op.

Example usage: mutablePrefs -= COUNTER_KEY

operator fun plusAssign(pair: Preferences.Pair<*>): Unit

Appends or replaces all pair to this MutablePreferences.

Example usage: mutablePrefs += COUNTER_KEY to 100

operator fun plusAssign(prefs: Preferences): Unit

Appends or replaces all pairs from prefs to this MutablePreferences. Keys in prefs will overwrite keys in this Preferences.

Example usage: mutablePrefs += preferencesOf(COUNTER_KEY to 100, NAME to "abcdef")

fun putAll(vararg pairs: Preferences.Pair<*>): Unit

Appends or replaces all pairs to this MutablePreferences.

fun <T : Any?> remove(key: Preferences.Key<T>): T

Remove a preferences from this MutablePreferences.

operator fun <T : Any?> set(key: Preferences.Key<T>, value: T): Unit

Set a key value pair in MutablePreferences.

Example usage: val COUNTER_KEY = intPreferencesKey("counter")

// Once edit completes successfully, preferenceStore will contain the incremented counter. preferenceStore.edit { prefs: MutablePreferences -> prefs\[COUNTER_KEY\] = prefs\[COUNTER_KEY\] :? 0 + 1 }

open fun toString(): String

For better debugging.