Struct dioxus_router::prelude::MemoryHistory

pub struct MemoryHistory<R: Routable> { /* private fields */ }

A HistoryProvider that stores all navigation information in memory.

Implementations

impl<R: Routable> MemoryHistory<R>

where <R as FromStr>::Err: Display,

pub fn with_initial_path(path: R) -> Self

Create a MemoryHistory starting at path.

#[derive(Clone, Routable, Debug, PartialEq)]
enum Route {
    #[route("/")]
    Index {},
    #[route("/some-other-page")]
    OtherPage {},
}

let mut history = MemoryHistory::<Route>::with_initial_path(Route::Index {});
assert_eq!(history.current_route(), Route::Index {});
assert_eq!(history.can_go_back(), false);

Trait Implementations

impl<R: Routable> Default for MemoryHistory<R>

where <R as FromStr>::Err: Display,

fn default() -> Self

Returns the “default value” for a type.

impl<R: Routable> HistoryProvider<R> for MemoryHistory<R>

fn current_route(&self) -> R

Get the path of the current URL.

fn can_go_back(&self) -> bool

Check whether there is a previous page to navigate back to.

fn go_back(&mut self)

Go back to a previous page.

fn can_go_forward(&self) -> bool

Check whether there is a future page to navigate forward to.

fn go_forward(&mut self)

Go forward to a future page.

fn push(&mut self, new: R)

Go to another page.

fn replace(&mut self, path: R)

Replace the current page with another one.

fn current_prefix(&self) -> Option<String>

Get the current path prefix of the URL.

fn external(&mut self, url: String) -> bool

Navigate to an external URL.

fn updater(&mut self, callback: Arc<dyn Fn() + Send + Sync>)

Provide the HistoryProvider with an update callback.