Struct RouteHandle 

pub struct RouteHandle { /* private fields */ }

A cloneable controller for one router’s process-local route stack.

Route changes are presentation state: they do not mutate the app document, participate in collaboration, or create undo entries.

Implementations

impl RouteHandle

pub fn new<S, I, R>(initial: S, routes: I) -> Result<RouteHandle, RouteError>

where S: Into<String>, I: IntoIterator<Item = R>, R: Into<String>,

Create a navigation stack from a finite route registry.

Errors

Returns an error when the registry is empty, contains a blank name, or does not contain initial.

pub fn current(&self) -> String

pub fn knows(&self, route: &str) -> bool

pub fn can_back(&self) -> bool

pub fn can_forward(&self) -> bool

pub fn history(&self) -> (Vec<String>, String, Vec<String>)

pub fn push(&self, route: impl Into<String>) -> Result<bool, RouteError>

Push a different route and clear forward history.

Errors

Returns RouteError::UnknownRoute without changing history.

pub fn replace(&self, route: impl Into<String>) -> Result<bool, RouteError>

Replace the current entry without extending back history.

Errors

Returns RouteError::UnknownRoute without changing history.

pub fn back(&self) -> bool

pub fn forward(&self) -> bool

pub fn reset(&self, route: impl Into<String>) -> Result<bool, RouteError>

Replace the complete history with one registered route.

Errors

Returns RouteError::UnknownRoute without changing history.

pub fn push_action( &self, route: impl Into<String>, ) -> Result<Box<dyn FnMut()>, RouteError>

A directly usable super::Button::on_click callback.

Errors

Returns an error immediately for an unknown route, rather than waiting for the user to click a dead control.

pub fn export_stack(&self) -> RouteSnapshot

Export the history for a same-process-session reload.

pub fn adopt_stack(&self, snapshot: &RouteSnapshot) -> Result<bool, RouteError>

Replace the history when every name is still registered.

Errors

Returns RouteError::UnknownRoute or RouteError::RevisionExhausted without changing history.

Trait Implementations

impl Clone for RouteHandle

fn clone(&self) -> RouteHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RouteHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.