StateValue

class StateValue<T : Any>(handle: SavedStateHandle, key: String, serializer: KSerializer<T>, json: Json = Json, default: T? = null) : ReadWriteProperty<Any?, T?> (source)

Serialized property delegate. Bind a property or supply a key before calling flow.

Constructors

constructor(handle: SavedStateHandle, key: String, serializer: KSerializer<T>, json: Json = Json, default: T? = null)

Read fallbacks do not persist another value; assignments still update the saved property.

Supplies a nullable fallback on reads and observation, without writing it to the handle.

fun flow(): StateFlow<T?>

Stable immediate observable state. The handle key is private; update through this delegate.

fun get(): T?

Current value; defaults only initialize absent keys.

open operator override fun getValue(thisRef: Any?, property: KProperty<*>): T?

Reads the payload saved under the resolved property key.

operator fun provideDelegate(ref: Any?, property: KProperty<*>): StateValue<T>

Resolves an implicit key once, when the property is declared.

Supplies a non-null fallback on reads and observation, without writing it to the handle.

fun set(value: T?)

Saves synchronously. Encoding failures leave the old value intact. Null does not remove the key.

open operator override fun setValue(thisRef: Any?, property: KProperty<*>, value: T?)

Serializes the assignment before replacing the saved payload.