Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
actual annotation class CircuitSerializable(val scope: KClass<*>)

Marks a concrete Screen or PopResult for serialization registration code generation in scope.

@MetaSerializable
@Target(allowedTargets = [AnnotationTarget.CLASS])
expect annotation class CircuitSerializable(val scope: KClass<*>)

Marks a concrete Screen or PopResult for serialization registration code generation in scope.

@MetaSerializable
@Target(allowedTargets = [AnnotationTarget.CLASS])
actual annotation class CircuitSerializable(val scope: KClass<*>)

Marks a concrete Screen or PopResult for serialization registration code generation in scope.

@MetaSerializable
@Target(allowedTargets = [AnnotationTarget.CLASS])
actual annotation class CircuitSerializable(val scope: KClass<*>)

Marks a concrete Screen or PopResult for serialization registration code generation in scope.

Link copied to clipboard

Registers a serializable Circuit screen or pop result for polymorphic serialization.

Functions

Link copied to clipboard
fun circuitSerializersModule(registrations: Iterable<CircuitSerializerRegistration>): SerializersModule

Creates a serializers module containing registrations.

Link copied to clipboard
fun SerializableCircuitSaver(configuration: SavedStateConfiguration = SavedStateConfiguration.DEFAULT, onRestoreError: (Throwable) -> Unit = {}): CircuitSaver

Returns a CircuitSaver that persists CircuitSaveable types with kotlinx serialization. It encodes them to SavedState with androidx.savedstate.

fun SerializableCircuitSaver(registrations: Iterable<CircuitSerializerRegistration>, configuration: SavedStateConfiguration = SavedStateConfiguration.DEFAULT, onRestoreError: (Throwable) -> Unit = {}): CircuitSaver

Returns a CircuitSaver that persists the screens and pop results supplied by registrations.