This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.

Struct yew_router::navigator::Navigator

source ·
pub struct Navigator { /* private fields */ }
Expand description

A struct to navigate between locations.

Implementations§

source§

impl Navigator

source

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

Returns basename of current navigator.

source

pub fn back(&self)

Navigate back 1 page.

source

pub fn forward(&self)

Navigate forward 1 page.

source

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

source

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

Pushes a Routable entry.

source

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

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

source

pub fn push_with_state<R, T>(&self, route: &R, state: T)
where R: Routable, T: 'static,

Pushes a Routable entry with state.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn kind(&self) -> NavigatorKind

Returns the Navigator kind.

Trait Implementations§

source§

impl Clone for Navigator

source§

fn clone(&self) -> Navigator

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Navigator

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for Navigator

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Navigator

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoPropValue<Option<T>> for T

source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<T> for T

source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

source§

impl<T> HasAllProps<(), T> for T