BackStack

true if the BackStack contains exactly one record.

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

The bottom-most record in the BackStack, or null if the BackStack is empty.

The number of records contained in this BackStack that will be seen by an iterator.

The top-most record in the BackStack, or null if the BackStack is empty.

Clear any saved state from the BackStack.

Whether the back stack contains the given record.

Whether a record with the given key is reachable within the back stack or saved state. Reachable means that it is either currently in the visible back stack or if we popped depth times, it would be found.

Peek at the Screen in the internal state store that have been saved using saveState.

Attempt to pop the top item off of the back stack, returning the popped Record if popping was successful or null if no entry was popped.

Pop records off the top of the backstack until one is found that matches the given predicate.

Push a new Record onto the back stack. The new record will become the top of the stack.

Push a new Screen onto the back stack. This will be enveloped in a Record and the new record will become the top of the stack.

Removes the state associated with the given screen from the internal state store.

Restores the saved state with the given screen, adding it on top of the existing entry list. If you wish to replace the current entry list, you should pop all of the existing entries off before calling this function.

Saves the current back stack entry list in an internal state store. It can be later restored by the root screen to restoreState.