viewmodel-savedstate/com.hoc081098.kmp.viewmodel.safe/safe

safe

inline fun <R> SavedStateHandle.safe(block: (SafeSavedStateHandle) -> R): R

Enables type-safe access to SavedStateHandle. You can use this with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

Example of usage:

val idKey = NullableSavedStateHandleKey.int("id")

// Get a value associated with the given key.
val id: Int? = savedStateHandle.safe { it[idKey] }

// Associate the given value with the key.
savedStateHandle.safe { it[idKey] = 42 }

// Remove a value associated with the given key.
savedStateHandle.safe { it.remove(idKey) }

// Get a StateFlow
val idStateFlow: StateFlow<Int?> = savedStateHandle.safe { it.getStateFlow(idKey) }

Receiver

SavedStateHandle to be wrapped and accessed safely.

Parameters

block

a block of code to be executed with SafeSavedStateHandle. Inside the block, you can use methods of SafeSavedStateHandle to access SavedStateHandle.

val SavedStateHandle.safe: SafeSavedStateHandle

Enables type-safe access to SavedStateHandle. You can use this with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

This is a another way to use SafeSavedStateHandle without a lambda.

Example of usage:

val idKey = NullableSavedStateHandleKey.int("id")

// Get a value associated with the given key.
val id: Int? = savedStateHandle.safe[idKey]

// Associate the given value with the key.
savedStateHandle.safe[idKey] = 42

// Remove a value associated with the given key.
savedStateHandle.safe.remove(idKey)

// Get a StateFlow
val idStateFlow: StateFlow<Int?> = savedStateHandle.safe.getStateFlow(idKey)

Receiver

SavedStateHandle to be wrapped and accessed safely.

Return

SafeSavedStateHandle to access SavedStateHandle safely.