Struct yew_router::prelude::Location

pub struct Location { /* private fields */ }

A history location.

This struct provides location information at the time [History::location] is called.

Implementations

impl Location

pub fn id(&self) -> Option<u32>

Returns a unique id of current location.

Returns None if current location is not created by gloo::history.

Warning

Depending on the sitation, the id may or may not be sequential / incremental.

pub fn path(&self) -> &str

Returns the pathname of current location.

pub fn query_str(&self) -> &str

Returns the queries of current URL in &str.

pub fn query<T>(&self) -> Result<T, HistoryError>where
    T: DeserializeOwned,

Returns the queries of current URL parsed as T.

pub fn hash(&self) -> &str

Returns the hash fragment of current URL.

pub fn state<T>(&self) -> Option<Rc<T>>where
    T: 'static,

Returns an Rc’ed state of current location.

Returns None if state is not created by gloo::history, or state fails to downcast.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl PartialEq<Location> for Location

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