gloo_history/
location.rs

1use std::any::Any;
2use std::rc::Rc;
3
4#[cfg(feature = "query")]
5use crate::{error::HistoryResult, query::FromQuery};
6
7/// A history location.
8///
9/// This struct provides location information at the time
10/// [`History::location`][crate::History::location] is called.
11#[derive(Clone, Debug)]
12pub struct Location {
13    pub(crate) path: Rc<String>,
14    pub(crate) query_str: Rc<String>,
15    pub(crate) hash: Rc<String>,
16    pub(crate) state: Option<Rc<dyn Any>>,
17    pub(crate) id: Option<u32>,
18}
19
20impl Location {
21    /// Returns a unique id of current location.
22    ///
23    /// Returns [`None`] if current location is not created by `gloo::history`.
24    ///
25    /// # Warning
26    ///
27    /// Depending on the situation, the id may or may not be sequential / incremental.
28    pub fn id(&self) -> Option<u32> {
29        self.id
30    }
31
32    /// Returns the `pathname` of current location.
33    pub fn path(&self) -> &str {
34        &self.path
35    }
36
37    /// Returns the queries of current URL in [`&str`].
38    pub fn query_str(&self) -> &str {
39        &self.query_str
40    }
41
42    /// Returns the queries of current URL parsed as `T`.
43    #[cfg(feature = "query")]
44    pub fn query<T>(&self) -> HistoryResult<T::Target, T::Error>
45    where
46        T: FromQuery,
47    {
48        let query = self.query_str().strip_prefix('?').unwrap_or("");
49        T::from_query(query)
50    }
51
52    /// Returns the hash fragment of current URL.
53    pub fn hash(&self) -> &str {
54        &self.hash
55    }
56
57    /// Returns an Rc'ed state of current location.
58    ///
59    /// Returns [`None`] if state is not created by `gloo::history`, or state fails to downcast.
60    pub fn state<T>(&self) -> Option<Rc<T>>
61    where
62        T: 'static,
63    {
64        self.state.clone().and_then(|m| m.downcast().ok())
65    }
66}
67
68impl PartialEq for Location {
69    fn eq(&self, rhs: &Self) -> bool {
70        if let Some(lhs) = self.id() {
71            if let Some(rhs) = rhs.id() {
72                return lhs == rhs;
73            }
74        }
75        false
76    }
77}
gloo_history/location.rs

gloo_history/
location.rs
