Struct gloo_history::HashHistory

pub struct HashHistory { /* private fields */ }

A History that is implemented with web_sys::History and stores path in #(fragment).

Panics

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

Implementations

impl HashHistory

pub fn new() -> Self

Creates a new HashHistory

Trait Implementations

impl Clone for HashHistory

fn clone(&self) -> HashHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HashHistory

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

Formats the value using the given formatter.

impl Default for HashHistory

fn default() -> Self

Returns the “default value” for a type.

impl From<HashHistory> for AnyHistory

fn from(m: HashHistory) -> AnyHistory

Converts to this type from the input type.

impl History for HashHistory

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 ) -> HistoryResult<(), Q::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 ) -> HistoryResult<(), Q::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 ) -> HistoryResult<(), Q::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 ) -> HistoryResult<(), Q::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.

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 HashHistory

fn eq(&self, other: &HashHistory) -> 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.

impl StructuralPartialEq for HashHistory