An opaque (empty) common type that holds saveable values to be saved and restored by native platforms that have a concept of System-initiated Process Death.

That means, the OS will give the chance for the process to keep the state of the application (normally using a serialization mechanism), and allow the app to restore its state later. That is commonly referred to as "state restoration".

required to act as a source input for a SavedStateReader or SavedStateWriter.

This class represents a container for persistable state data. It is designed to be platform-agnostic, allowing seamless state saving and restoration across different environments.

Summary

Extension functions

inline T
<T : Any?> SavedState.read(block: SavedStateReader.() -> T)

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.

Cmn
inline T
<T : Any?> SavedState.write(block: SavedStateWriter.() -> T)

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.

Cmn

Extension functions

inline fun <T : Any?> SavedState.read(block: SavedStateReader.() -> T): T

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.

IMPORTANT: The SavedStateReader passed as a receiver to the block is valid only inside that function. Using it outside of the function may produce an unspecified behavior.

Parameters
block: SavedStateReader.() -> T

A lambda function that performs read operations using the SavedStateReader.

Returns
T

The result of the lambda function's execution.

inline fun <T : Any?> SavedState.write(block: SavedStateWriter.() -> T): T

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.

IMPORTANT: The SavedStateWriter passed as a receiver to the block is valid only inside that function. Using it outside of the function may produce an unspecified behavior.

Parameters
block: SavedStateWriter.() -> T

A lambda function that performs write operations using the SavedStateWriter.

Returns
T

The result of the lambda function's execution.