Struct yew_router::history::MemoryHistory

pub struct MemoryHistory { /* private fields */ }

A History that is implemented with in memory history stack and is usable in most targets.

Panics

MemoryHistory does not support relative paths and will panic if routes are not starting with /.

Implementations

impl MemoryHistory

pub fn new() -> MemoryHistory

Creates a new MemoryHistory with a default entry of ‘/’.

pub fn with_entries<'a>(
    entries: impl IntoIterator<Item = impl Into<Cow<'a, str>>>
) -> MemoryHistory

Creates a new MemoryHistory with entires.

Trait Implementations

impl Clone for MemoryHistory

fn clone(&self) -> MemoryHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryHistory

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

Formats the value using the given formatter.

impl Default for MemoryHistory

fn default() -> MemoryHistory

Returns the “default value” for a type.

impl From<MemoryHistory> for AnyHistory

fn from(m: MemoryHistory) -> AnyHistory

Converts to this type from the input type.

impl History for MemoryHistory

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.

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<(), HistoryError>where
    Q: Serialize,

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<(), HistoryError>where
    Q: Serialize,

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<(), HistoryError>where
    Q: Serialize,
    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<(), HistoryError>where
    Q: Serialize,
    T: 'static,

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

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

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

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<MemoryHistory> for MemoryHistory

fn eq(&self, rhs: &MemoryHistory) -> bool

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

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.