backstack/com.slack.circuit.backstack/SaveableBackStack

SaveableBackStack

class SaveableBackStack : BackStack<SaveableBackStack.Record> (source)

A BackStack that supports saving its state via rememberSaveable. See rememberSaveableBackStack.

Constructors

SaveableBackStack

constructor(root: Screen)

constructor(root: SaveableBackStack.Record)

Types

Record

data class Record(val screen: Screen, val args: Map<String, Any?> = emptyMap(), val key: String = Uuid.random().toString()) : BackStack.Record

Properties

currentRecord

open override val currentRecord: SaveableBackStack.Record?

isAtRoot

val BackStack<out BackStack.Record>.isAtRoot: Boolean

true if the BackStack contains exactly one record.

isEmpty

val BackStack<out BackStack.Record>.isEmpty: Boolean

true if the BackStack contains no records. Iterable.firstOrNull will return null.

rootRecord

open override val rootRecord: SaveableBackStack.Record?

size

open override val size: Int

topRecord

open override val topRecord: SaveableBackStack.Record?

Functions

backward

open override fun backward(): Boolean

Backward navigation is not supported by the BackStack as you are unable to go forward again.

clearState

fun BackStack<out BackStack.Record>.clearState()

Clear any saved state from the BackStack.

containsRecord

open override fun containsRecord(record: SaveableBackStack.Record, includeSaved: Boolean): Boolean

forward

open override fun forward(): Boolean

Forward navigation is not supported by the BackStack.

isRecordReachable

open override fun isRecordReachable(key: String, depth: Int, includeSaved: Boolean): Boolean

iterator

open operator override fun iterator(): Iterator<SaveableBackStack.Record>

peekState

open override fun peekState(): List<Screen>

pop

open override fun pop(): SaveableBackStack.Record?

popUntil

open fun popUntil(predicate: (SaveableBackStack.Record) -> Boolean): List<SaveableBackStack.Record>

push

open override fun push(record: SaveableBackStack.Record): Boolean

open override fun push(screen: Screen): Boolean

fun push(screen: Screen, args: Map<String, Any?>): Boolean

removeState

open override fun removeState(screen: Screen): Boolean

restoreState

open override fun restoreState(screen: Screen): Boolean

saveState

open override fun saveState()

snapshot

open override fun snapshot(): NavStackList<SaveableBackStack.Record>?