Struct dioxus_router::UseRoute

pub struct UseRoute { /* private fields */ }

A handle to the current location of the router.

Implementations

impl UseRoute

pub fn url(&self) -> &Url

Get the underlying Url of the current location.

pub fn query<T: DeserializeOwned>(&self) -> Option<T>

Get the first query parameter given the parameter name.

If you need to get more than one parameter, use [query_pairs] on the Url instead.

pub fn query_param(&self, param: &str) -> Option<Cow<'_, str>>

Get the first query parameter given the parameter name.

If you need to get more than one parameter, use [query_pairs] on the Url instead.

pub fn nth_segment(&self, n: usize) -> Option<&str>

Returns the nth segment in the path. Paths that end with a slash have the slash removed before determining the segments. If the path has fewer segments than n then this method returns None.

pub fn last_segment(&self) -> Option<&str>

Returns the last segment in the path. Paths that end with a slash have the slash removed before determining the segments. The root path, /, will return an empty string.

pub fn segment(&self, name: &str) -> Option<&str>

Get the named parameter from the path, as defined in your router. The value will be parsed into the type specified by T by calling value.parse::<T>(). This method returns None if the named parameter does not exist in the current path.

pub fn parse_segment<T>(&self, name: &str) -> Option<Result<T, T::Err>> where
    T: FromStr, 

Get the named parameter from the path, as defined in your router. The value will be parsed into the type specified by T by calling value.parse::<T>(). This method returns None if the named parameter does not exist in the current path.