NavBackStackSerializer

A KSerializer for NavBackStack.

This serializer wraps a KSerializer for the element type T, enabling serialization and deserialization of NavBackStack instances. The serialization of individual elements is delegated to the provided elementSerializer.

If your stack elements T are open polymorphic (e.g., a interface for different screens), the provided elementSerializer must be correctly configured to handle this.

import androidx.navigation3.runtime.NavBackStack
import androidx.navigation3.runtime.samples.RememberNavBackStackSamples.Details
import androidx.navigation3.runtime.samples.RememberNavBackStackSamples.Home
import androidx.navigation3.runtime.samples.RememberNavBackStackSamples.Screen
import androidx.navigation3.runtime.serialization.NavBackStackSerializer
import androidx.savedstate.serialization.decodeFromSavedState
import androidx.savedstate.serialization.encodeToSavedState

// On Android, the no-argument overload uses reflection and requires no configuration.
// This will throw a runtime exception on non-Android platforms during serialization.
val serializer = NavBackStackSerializer<Screen>()

val backStack = NavBackStack(Home("abc"), Details(42))
val encoded = encodeToSavedState(serializer, backStack)
val decoded = decodeFromSavedState(serializer, encoded)
Parameters
<T : NavKey>

The type of elements stored in the NavBackStack.

Summary

Public constructors
<T : NavKey> NavBackStackSerializer(
    elementSerializer: <Error class: unknown class><T>
)
Cmn

Public functions
open NavBackStack<T>
Cmn
open Unit
Cmn

Public properties
open <Error class: unknown class>
Cmn

Public constructors

Cmn 
<T : NavKey> NavBackStackSerializer(
    elementSerializer: <Error class: unknown class><T>
)
Parameters
<T : NavKey>

The type of elements stored in the NavBackStack.
elementSerializer: <Error class: unknown class><T>

The KSerializer used to serialize and deserialize individual elements.

Public functions

deserialize

Cmn 
open fun deserialize(decoder: <Error class: unknown class>): NavBackStack<T>

serialize

Cmn 
open fun serialize(encoder: <Error class: unknown class>, value: NavBackStack<T>): Unit

Public properties

descriptor

Cmn
Added in 1.0.0-alpha10
open val descriptor: <Error class: unknown class>