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

Enum AnyHistory

pub enum AnyHistory {
    Browser(BrowserHistory),
    Hash(HashHistory),
    Memory(MemoryHistory),
}
Expand description

A History that provides a universal API to the underlying history type.

Variants§

§

Browser(BrowserHistory)

A Browser History.

§

Hash(HashHistory)

A Hash History

§

Memory(MemoryHistory)

A Memory History

Trait Implementations§

§

impl Clone for AnyHistory

§

fn clone(&self) -> AnyHistory

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
§

impl Debug for AnyHistory

§

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

Formats the value using the given formatter. Read more
§

impl From<BrowserHistory> for AnyHistory

§

fn from(m: BrowserHistory) -> AnyHistory

Converts to this type from the input type.
§

impl From<HashHistory> for AnyHistory

§

fn from(m: HashHistory) -> AnyHistory

Converts to this type from the input type.
§

impl From<MemoryHistory> for AnyHistory

§

fn from(m: MemoryHistory) -> AnyHistory

Converts to this type from the input type.
§

impl History for AnyHistory

§

fn len(&self) -> usize

Returns the number of elements in History.
§

fn go(&self, delta: isize)

Loads a specific page in History with a delta relative to current page. Read more
§

fn push<'a>(&self, route: impl Into<Cow<'a, str>>)

Pushes a route entry with None being the state.
§

fn replace<'a>(&self, route: impl Into<Cow<'a, str>>)

Replaces the current history entry with provided route and None state.
§

fn push_with_state<'a, T>(&self, route: impl Into<Cow<'a, str>>, state: T)
where T: 'static,

Pushes a route entry with state.
§

fn replace_with_state<'a, T>(&self, route: impl Into<Cow<'a, str>>, state: T)
where T: 'static,

Replaces the current history entry with provided route and state.
§

fn push_with_query<'a, Q>( &self, route: impl Into<Cow<'a, str>>, query: Q, ) -> Result<(), <Q as ToQuery>::Error>
where Q: ToQuery,

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

fn replace_with_query<'a, Q>( &self, route: impl Into<Cow<'a, str>>, query: Q, ) -> Result<(), <Q as ToQuery>::Error>
where Q: ToQuery,

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

fn push_with_query_and_state<'a, Q, T>( &self, route: impl Into<Cow<'a, str>>, query: Q, state: T, ) -> Result<(), <Q as ToQuery>::Error>
where Q: ToQuery, T: 'static,

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

fn replace_with_query_and_state<'a, Q, T>( &self, route: impl Into<Cow<'a, str>>, query: Q, state: T, ) -> Result<(), <Q as ToQuery>::Error>
where Q: ToQuery, T: 'static,

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

fn listen<CB>(&self, callback: CB) -> HistoryListener
where CB: Fn() + 'static,

Creates a Listener that will be notified when current state changes. Read more
§

fn location(&self) -> Location

Returns current Location.
§

fn is_empty(&self) -> bool

Returns true if the current History is empty.
§

fn back(&self)

Moves back 1 page in History.
§

fn forward(&self)

Moves forward 1 page in History.
§

impl PartialEq for AnyHistory

§

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

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

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 AnyHistory

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

source§

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>,

source§

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>,

source§

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