Struct RouterController 

pub struct RouterController { /* private fields */ }

Owns the destination stack and reactive state for its routes.

Implementations

impl RouterController

pub fn new() -> Self

Creates an empty controller in the active UI session.

pub fn with_root(root_dest: impl RouterDestination + 'static) -> Self

Creates a controller seeded with a root destination.

pub fn with_root_shared(root_dest: Arc<dyn RouterDestination>) -> Self

Creates a controller seeded with a shared root destination.

pub fn push<T: RouterDestination + 'static>(&mut self, destination: T)

Pushes a destination with its own state lifetime.

pub fn push_shared(&mut self, destination: Arc<dyn RouterDestination>)

Pushes a shared destination with its own state lifetime.

pub fn pop(&mut self) -> Option<Arc<dyn RouterDestination>>

Pops the current destination and releases its route state.

pub fn replace<T: RouterDestination + 'static>( &mut self, destination: T, ) -> Option<Arc<dyn RouterDestination>>

Replaces the current destination, or pushes into an empty stack.

pub fn replace_shared( &mut self, destination: Arc<dyn RouterDestination>, ) -> Option<Arc<dyn RouterDestination>>

Replaces the current destination with a shared destination.

pub fn is_empty(&self) -> bool

Returns whether the stack is empty.

pub fn len(&self) -> usize

Returns the number of destinations.

pub fn last(&self) -> Option<&dyn RouterDestination>

Returns the current destination.

pub fn current_is<D: RouterDestination + 'static>(&self) -> bool

Returns whether the current destination has type D.

pub fn init_or_get<T, F, R>(&self, id: &str, f: F) -> R

where T: Default + Send + Sync + 'static, F: FnOnce(ShardState<T>) -> R,

Gets or initializes state owned by the current route.

pub fn init_or_get_with_lifecycle<T, F, R>( &self, id: &str, lifecycle: ShardStateLifeCycle, f: F, ) -> R

where T: Default + Send + Sync + 'static, F: FnOnce(ShardState<T>) -> R,

Gets or initializes state owned by a route or this controller.

pub fn clear(&mut self)

Clears all destinations and releases their route state.

pub fn reset(&mut self, root_dest: impl RouterDestination + 'static)

Clears the stack and installs a new root destination.

pub fn reset_shared(&mut self, root_dest: Arc<dyn RouterDestination>)

Clears the stack and installs a shared root destination.

Trait Implementations

impl Default for RouterController

fn default() -> Self

Returns the “default value” for a type.

impl Drop for RouterController

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.