Struct seed::browser::url::Url

pub struct Url { /* private fields */ }

URL used for routing.

• It represents relative URL.
• Two, almost identical, Urls that differ only with differently advanced internal path or hash path iterators (e.g. next_path_part() was called on one of them) are considered different also during comparison.

(If the features above are problems for you, create an issue)

Implementations

impl Url

pub fn new() -> Self

Creates a new Url with the empty path.

pub fn go_and_push(&self)

Change the browser URL, but do not trigger a page load.

This will add a new entry to the browser history.

References

• MDN docs

pub fn go_and_replace(&self)

Change the browser URL, but do not trigger a page load.

This will NOT add a new entry to the browser history.

References

• MDN docs

pub fn current() -> Url

Creates a new Url from the one that is currently set in the browser.

pub fn next_path_part(&mut self) -> Option<&str>

Advances the internal path iterator and returns the next path part as Option<&str>.

Example

match url.next_path_part() {
   None => Page::Home,
   Some("report") => Page::Report(page::report::init(url)),
   _ => Page::Unknown(url),
}

pub fn next_hash_path_part(&mut self) -> Option<&str>

Advances the internal hash path iterator and returns the next hash path part as Option<&str>.

Example

match url.next_hash_path_part() {
   None => Page::Home,
   Some("report") => Page::Report(page::report::init(url)),
   _ => Page::Unknown(url),
}

pub fn remaining_path_parts(&mut self) -> Vec<&str>

Collects the internal path iterator and returns it as Vec<&str>.

Example

match url.remaining_path_parts().as_slice() {
   [] => Page::Home,
   ["report", rest @ ..] => {
       match rest {
           ["day"] => Page::ReportDay,
           _ => Page::ReportWeek,
       }
   },
   _ => Page::NotFound,
}

pub fn remaining_hash_path_parts(&mut self) -> Vec<&str>

Collects the internal hash path iterator and returns it as Vec<&str>.

Example

match url.remaining_hash_path_parts().as_slice() {
   [] => Page::Home,
   ["report", rest @ ..] => {
       match rest {
           ["day"] => Page::ReportDay,
           _ => Page::ReportWeek,
       }
   },
   _ => Page::NotFound,
}

pub fn add_path_part(self, path_part: impl Into<String>) -> Self

Adds given path part and returns updated Url.

Example

let link_to_blog = url.add_path_part("blog");

pub fn add_hash_path_part(self, hash_path_part: impl Into<String>) -> Self

Adds given hash path part and returns updated Url. It also changes hash.

Example

let link_to_blog = url.add_hash_path_part("blog");

pub fn to_base_url(&self) -> Self

Clone the Url and strip remaining path parts.

pub fn to_hash_base_url(&self) -> Self

Clone the Url and strip remaining hash path parts.

pub fn set_path<T: ToString>(
    self,
    into_path_iterator: impl IntoIterator<Item = T>
) -> Self

Sets path and returns updated Url. It also resets internal path iterator.

Example

Url::new().set_path(&["my", "path"])

References

• MDN docs

pub fn set_hash_path<T: ToString>(
    self,
    into_hash_path_iterator: impl IntoIterator<Item = T>
) -> Self

Sets hash path and returns updated Url. It also resets internal hash path iterator and sets hash.

Example

Url::new().set_hash_path(&["my", "path"])

References

• MDN docs

pub fn set_hash(self, hash: impl Into<String>) -> Self

Sets hash and returns updated Url. I also sets hash_path.

Example

Url::new().set_hash("my_hash")

References

• MDN docs

pub fn set_search(self, search: impl Into<UrlSearch>) -> Self

Sets search and returns updated Url.

Example

Url::new().set_search(UrlSearch::new(vec![
    ("x", vec!["1"]),
    ("sort_by", vec!["date", "name"]),
])

References

• MDN docs

pub fn path(&self) -> &[String]

Get path.

References

• MDN docs

pub fn hash_path(&self) -> &[String]

Get hash path.

pub fn hash(&self) -> Option<&String>

Get hash.

References

• MDN docs

pub const fn search(&self) -> &UrlSearch

Get search.

References

• MDN docs

pub fn search_mut(&mut self) -> &mut UrlSearch

Get mutable search.

References

• MDN docs

pub fn go_and_load(&self)

Change the browser URL and trigger a page load.

pub fn go_and_load_with_str(url: impl AsRef<str>)

Change the browser URL and trigger a page load.

Provided url isn’t checked and it’s passed into location.href.

pub fn reload()

Trigger a page reload.

pub fn reload_and_skip_cache()

Trigger a page reload and force reloading from the server.

pub fn go_back(steps: i32)

Move back in History.

• steps: 0 only reloads the current page.
• Negative steps move you forward - use rather Url::go_forward instead.
• If there is no previous page, this call does nothing.

pub fn go_forward(steps: i32)

Move back in History.

• steps: 0 only reloads the current page.
• Negative steps move you back - use rather Url::go_back instead.
• If there is no next page, this call does nothing.

pub fn skip_base_path(self, path_base: &[String]) -> Self

If the current Url’s path prefix is equal to path_base, then reset the internal path iterator and advance it to skip the prefix (aka path_base).

It’s used mostly by Seed internals, but it can be useful in combination with orders.clone_base_path().

pub fn skip_hash_base_path(self, hash_path_base: &[String]) -> Self

If the current Url’s hash path prefix is equal to hash_path_base, then reset the internal hash path iterator and advance it to skip the prefix (aka hash_path_base).

It’s used mostly by Seed internals.

pub fn decode_uri_component(
    component: impl AsRef<str>
) -> Result<String, JsValue>

Decodes a Uniform Resource Identifier (URI) component. Aka percent-decoding.

Note: All components are automatically decoded when it’s possible. You can find undecodable components in the vector returned from methods invalid_components or invalid_components_mut.

Example

Url::decode_uri_component("Hello%20G%C3%BCnter"); // => "Hello Günter"

Errors

Returns error when decoding fails - e.g. “Error: malformed URI sequence”.

pub fn encode_uri_component(component: impl AsRef<str>) -> String

Encode to a Uniform Resource Identifier (URI) component. Aka percent-encoding.

Note: All components are automatically encoded in Display implementation for Url - i.e. url.to_string() returns encoded url.

Example

Url::encode_uri_component("Hello Günter"); // => "Hello%20G%C3%BCnter"

pub fn invalid_components(&self) -> &[String]

Get invalid components.

Undecodable / unparsable components are invalid.

pub fn invalid_components_mut(&mut self) -> &mut Vec<String>

Get mutable invalid components.

Undecodable / unparsable components are invalid.

Trait Implementations

impl Clone for Url

fn clone(&self) -> Url

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Url

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

Formats the value using the given formatter.

impl Default for Url

fn default() -> Url

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Url

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Url

All components are automatically encoded.

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

Formats the value using the given formatter.

impl From<&'_ Url> for Url

fn from(url: &Url) -> Self

Creates a new Url from the browser native url. Url’s components are decoded if possible. When decoding fails, the component is cloned into invalid_components and the original value is used.

impl<'a> From<&'a Url> for Cow<'a, Url>

fn from(url: &'a Url) -> Cow<'a, Url>

Converts to this type from the input type.

impl<'a> From<Url> for Request<'a>

fn from(url: Url) -> Request<'a>

Converts to this type from the input type.

impl<'a> From<Url> for Cow<'a, Url>

fn from(url: Url) -> Cow<'a, Url>

Converts to this type from the input type.

impl FromStr for Url

fn from_str(str_url: &str) -> Result<Self, Self::Err>

Creates a new Url from &str.

Errors

Returns error when url cannot be parsed.

Note: When only some components are undecodable, no error is returned - that components are saved into the Urls invalid_components - see methods Url::invalid_components and Url::invalid_components_mut.

type Err = String

The associated error which can be returned from parsing.

impl PartialEq<Url> for Url

fn eq(&self, other: &Url) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Url) -> bool

This method tests for !=.

impl Serialize for Url

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Url