respawn/io.buszi.respawn

Package-level declarations

Types

RespawnDefaults

object RespawnDefaults

Default constants used by the Respawn library for saving and restoring state.

Properties

isRestored

@get:MainThread

val SavedStateHandle.isRestored: Boolean

Checks if the default state was successfully restored from process death. Must be called after respawnMutableStateFlow has been initialized for the default key.

Functions

isRestored

@MainThread

fun SavedStateHandle.isRestored(key: String = DEFAULT_KEY): Boolean

Checks if the state associated with the given key was successfully restored from process death.

onInit

@MainThread

inline fun SavedStateHandle.onInit(key: String = DEFAULT_KEY, init: () -> Unit): SavedStateHandle

Executes the given init block if the state for key was NOT restored from process death.

onRestore

@MainThread

inline fun SavedStateHandle.onRestore(key: String = DEFAULT_KEY, restore: () -> Unit): SavedStateHandle

Executes the given restore block if the state for key WAS restored from process death.

respawnMutableStateFlow

@MainThread

inline fun <T : @Serializable Any> SavedStateHandle.respawnMutableStateFlow(init: () -> T, key: String = RespawnDefaults.DEFAULT_KEY, configuration: SavedStateConfiguration = SavedStateConfiguration.DEFAULT): MutableStateFlow<T>

Creates a MutableStateFlow that is automatically saved and restored across process death.