SavedStateSerializer

Artifact: androidx.savedstate:savedstate

Added in 1.3.0

Kotlin |Java

public static class SavedStateSerializer implements KSerializer

A serializer for SavedState. This serializer uses SavedState's API to save/load a SavedState.

Note that this serializer should be used with androidx.savedstate.serialization.SavedStateEncoder or androidx.savedstate.serialization.SavedStateDecoder only. Using it with other Encoders/Decoders may throw IllegalArgumentException.

import androidx.savedstate.serialization.serializers.SavedStateSerializer

@Serializable
data class MyModel(
    @Serializable(with = SavedStateSerializer::class) val savedState: SavedState
)

See also
`encodeToSavedState`
`decodeFromSavedState`

Summary

Public fields
`static @NonNull SavedStateSerializer`	`INSTANCE`

Public methods
`@NonNull SavedState`	`deserialize(@NonNull Decoder decoder)`
`@NonNull SerialDescriptor`	`getDescriptor()`
`void`	`serialize(@NonNull Encoder encoder, @NonNull SavedState value)`

Public fields

INSTANCE

Added in 1.3.0

public static @NonNull SavedStateSerializer INSTANCE

Public methods

deserialize

Added in 1.3.0

public @NonNull SavedState deserialize(@NonNull Decoder decoder)

getDescriptor

Added in 1.3.0

public @NonNull SerialDescriptor getDescriptor()

serialize

public void serialize(@NonNull Encoder encoder, @NonNull SavedState value)