Struct Navigator

pub struct Navigator { /* private fields */ }

A struct to navigate between locations.

Implementations

impl Navigator

pub fn basename(&self) -> Option<&str>

Returns basename of current navigator.

pub fn back(&self)

Navigate back 1 page.

pub fn forward(&self)

Navigate forward 1 page.

pub fn go(&self, delta: isize)

Navigate to a specific page with a delta relative to current page.

See: https://developer.mozilla.org/en-US/docs/Web/API/History/go

pub fn push<R>(&self, route: &R)

where R: Routable,

Pushes a Routable entry.

pub fn replace<R>(&self, route: &R)

where R: Routable,

Replaces the current history entry with provided Routable and None state.

pub fn push_with_state<R, T>(&self, route: &R, state: T)

where R: Routable, T: 'static,

Pushes a Routable entry with state.

pub fn replace_with_state<R, T>(&self, route: &R, state: T)

where R: Routable, T: 'static,

Replaces the current history entry with provided Routable and state.

pub fn push_with_query<R, Q>( &self, route: &R, query: &Q, ) -> NavigationResult<()>

where R: Routable, Q: Serialize,

Same as .push() but affix the queries to the end of the route.

pub fn replace_with_query<R, Q>( &self, route: &R, query: &Q, ) -> NavigationResult<()>

where R: Routable, Q: Serialize,

Same as .replace() but affix the queries to the end of the route.

pub fn push_with_query_and_state<R, Q, T>( &self, route: &R, query: &Q, state: T, ) -> NavigationResult<()>

where R: Routable, Q: Serialize, T: 'static,

Same as .push_with_state() but affix the queries to the end of the route.

pub fn replace_with_query_and_state<R, Q, T>( &self, route: &R, query: &Q, state: T, ) -> NavigationResult<()>

where R: Routable, Q: Serialize, T: 'static,

Same as .replace_with_state() but affix the queries to the end of the route.

pub fn kind(&self) -> NavigatorKind

Returns the Navigator kind.

Trait Implementations

impl Clone for Navigator

fn clone(&self) -> Navigator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Navigator

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

Formats the value using the given formatter.

impl PartialEq for Navigator

fn eq(&self, other: &Navigator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Navigator