Struct MemoryHistory

pub struct MemoryHistory { /* private fields */ }

A History provider that stores all navigation information in memory.

Implementations

impl MemoryHistory

pub fn with_initial_path(path: impl ToString) -> Self

Create a MemoryHistory starting at path.

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

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

pub fn with_prefix(self, prefix: impl ToString) -> Self

Set the base path for the history. All routes will be prefixed with this path when rendered.

let mut history = MemoryHistory::default().with_prefix("/my-app");

// The base path is set to "/my-app"
assert_eq!(history.current_prefix(), Some("/my-app".to_string()));

Trait Implementations

impl Default for MemoryHistory

fn default() -> Self

Returns the “default value” for a type.

impl History for MemoryHistory

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

Get the current path prefix of the URL.

fn current_route(&self) -> String

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(&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(&self)

Go forward to a future page.

fn push(&self, new: String)

Go to another page.

fn replace(&self, path: String)

Replace the current page with another one.

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

Navigate to an external URL.

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

Provide the [HistoryProvider] with an update callback.

fn include_prevent_default(&self) -> bool

Whether the router should include the legacy prevent default attribute instead of the new prevent default method. This should only be used by liveview.