SavedStateConfigKt

Added in 1.3.0-alpha09

public final class SavedStateConfigKt

Summary

Public methods
static final @NonNull SavedStateConfig

Creates an instance of SavedStateConfig configured from the optionally given from and adjusted with builderAction.

Public methods

SavedStateConfig

public static final @NonNull SavedStateConfig SavedStateConfig(
    @NonNull SavedStateConfig from,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateConfig.Builder, Unit> builderAction
)

Creates an instance of SavedStateConfig configured from the optionally given from and adjusted with builderAction.

import androidx.savedstate.serialization.SavedStateConfig
import androidx.savedstate.serialization.decodeFromSavedState
import androidx.savedstate.serialization.encodeToSavedState

val config = SavedStateConfig {
    serializersModule = SerializersModule {
        polymorphic(Any::class) { subclass(String::class) }
    }
}
val value = "foo"
val encoded =
    encodeToSavedState(
        serializer = PolymorphicSerializer(Any::class),
        value = value,
        config = config
    )
val decoded =
    decodeFromSavedState(
        deserializer = PolymorphicSerializer(Any::class),
        savedState = encoded,
        config = config
    )
Parameters
@NonNull SavedStateConfig from

An optional initial SavedStateConfig to start with. Defaults to SavedStateConfig.DEFAULT.
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateConfig.Builder, Unit> builderAction

A lambda function to configure the Builder for additional customization.
Returns
@NonNull SavedStateConfig

A new SavedStateConfig instance configured based on the provided parameters.