Struct silkenweb::router::UrlPath

pub struct UrlPath { /* private fields */ }

Represent the path portion of a URL (including any query string)

Implementations

impl UrlPath

pub fn new(path: &str) -> Self

Create a new UrlPath

path should have any special characters percent escaped. Any leading '/'s are removed.

pub fn path(&self) -> &str

Get the path portion of the UrlPath

assert_eq!(UrlPath::new("path?query_string").path(), "path");
assert_eq!(UrlPath::new("?query_string").path(), "");
assert_eq!(UrlPath::new("?").path(), "");
assert_eq!(UrlPath::new("").path(), "");

pub fn path_components(&self) -> impl Iterator<Item = &str>

Get the path components of the UrlPath

let path = UrlPath::new("path1/path2/path3");
let components: Vec<&str> = path.path_components().collect();
assert_eq!(&components, &["path1", "path2", "path3"]);

let path = UrlPath::new("");
assert_eq!(path.path_components().next(), None);

let path = UrlPath::new("path1//path2"); // Note the double `'/'`
let components: Vec<&str> = path.path_components().collect();
assert_eq!(&components, &["path1", "", "path2"]);

pub fn path_components_vec(&self) -> Vec<&str>

As UrlPath::path_components but collected into a Vec

pub fn query_string(&self) -> &str

Get the query string portion of the UrlPath

assert_eq!(
    UrlPath::new("path?query_string").query_string(),
    "query_string"
);
assert_eq!(UrlPath::new("?query_string").query_string(), "query_string");
assert_eq!(UrlPath::new("?").query_string(), "");
assert_eq!(UrlPath::new("").query_string(), "");
assert_eq!(UrlPath::new("#hash").query_string(), "");
assert_eq!(
    UrlPath::new("?query_string#hash").query_string(),
    "query_string"
);

pub fn query(&self) -> impl Iterator<Item = (&str, Option<&str>)>

Split the query string into key/value pairs

let path = UrlPath::new("path?x=1&y=2&flag");
let kv_args: Vec<(&str, Option<&str>)> = path.query().collect();
assert_eq!(
    &kv_args,
    &[("x", Some("1")), ("y", Some("2")), ("flag", None)]
);

pub fn query_map(&self) -> HashMap<&str, Option<&str>>

As UrlPath::query but collected into a HashMap

pub fn hash(&self) -> &str

Get the query string portion of the UrlPath

assert_eq!(UrlPath::new("path?query_string#hash").hash(), "hash");
assert_eq!(UrlPath::new("#hash").hash(), "hash");
assert_eq!(UrlPath::new("#").hash(), "");
assert_eq!(UrlPath::new("").hash(), "");

pub fn as_str(&self) -> &str

Get the whole path as a &str

Trait Implementations

impl Clone for UrlPath

fn clone(&self) -> UrlPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for UrlPath

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for UrlPath

fn from(path: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for UrlPath

fn from(path: String) -> Self

Converts to this type from the input type.

impl PartialEq for UrlPath

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

impl Eq for UrlPath

impl StructuralPartialEq for UrlPath