HashHistory

Struct HashHistory 

Source
pub struct HashHistory { /* private fields */ }
Expand description

A dioxus_history::History provider that integrates with a browser via the History API but uses the url fragment for the route. This allows serving as a single html file or on a single url path.

Implementations§

Source§

impl HashHistory

Source

pub fn new(do_scroll_restoration: bool) -> Self

Create a new HashHistory.

If do_scroll_restoration is true, HashHistory will take control of the history state. It’ll also set the browsers scroll restoration to manual.

Trait Implementations§

Source§

impl Default for HashHistory

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl History for HashHistory

Source§

fn current_route(&self) -> String

Get the path of the current URL. Read more
Source§

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

Get the current path prefix of the URL. Read more
Source§

fn go_back(&self)

Go back to a previous page. Read more
Source§

fn go_forward(&self)

Go forward to a future page. Read more
Source§

fn push(&self, state: String)

Go to another page. Read more
Source§

fn replace(&self, state: String)

Replace the current page with another one. Read more
Source§

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

Navigate to an external URL. Read more
Source§

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

Provide the History with an update callback. Read more
Source§

fn can_go_back(&self) -> bool

Check whether there is a previous page to navigate back to. Read more
Source§

fn can_go_forward(&self) -> bool

Check whether there is a future page to navigate forward to. Read more
Source§

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.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more