Struct RelativeDIDUrl

pub struct RelativeDIDUrl { /* private fields */ }

A relative DID Url with the path, query, and fragment components defined according to URI syntax.

E.g.

• "/path?query#fragment"
• "/path"
• "?query"
• "#fragment"

Implementations

impl RelativeDIDUrl

pub fn new() -> RelativeDIDUrl

Create an empty RelativeDIDUrl.

pub fn is_empty(&self) -> bool

Returns whether all URL segments are empty.

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

Return the path component, including the leading ‘/’.

E.g. "/path/sub-path/resource"

pub fn set_path(&mut self, value: Option<&str>) -> Result<(), Error>

Attempt to set the path component. The path must start with a ‘/’.

Example

url.set_path(Some("/path/sub-path/resource")).unwrap();
assert_eq!(url.path().unwrap(), "/path/sub-path/resource");
assert_eq!(url.to_string(), "/path/sub-path/resource");

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

Return the path component, excluding the leading ‘?’ delimiter.

E.g. "?query1=a&query2=b" -> "query1=a&query2=b"

pub fn set_query(&mut self, value: Option<&str>) -> Result<(), Error>

Attempt to set the query component. A leading ‘?’ is ignored.

Example

// Set the query with a leading '?'
url.set_query(Some("?query1=a")).unwrap();
assert_eq!(url.query().unwrap(), "query1=a");
assert_eq!(url.to_string(), "?query1=a");

// Set the query without a leading '?'
url.set_query(Some("query1=a&query2=b")).unwrap();
assert_eq!(url.query().unwrap(), "query1=a&query2=b");
assert_eq!(url.to_string(), "?query1=a&query2=b");

pub fn query_pairs(&self) -> Parse<'_>

Return an iterator of (name, value) pairs in the query string.

E.g. "query1=a&query2=b" -> [("query1", "a"), ("query2", "b")]

See [form_urlencoded::parse].

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

Return the fragment component, excluding the leading ‘#’ delimiter.

E.g. "#fragment" -> "fragment"

pub fn set_fragment(&mut self, value: Option<&str>) -> Result<(), Error>

Attempt to set the fragment component. A leading ‘#’ is ignored.

Example

// Set the fragment with a leading '#'
url.set_fragment(Some("#fragment1")).unwrap();
assert_eq!(url.fragment().unwrap(), "fragment1");
assert_eq!(url.to_string(), "#fragment1");

// Set the fragment without a leading '#'
url.set_fragment(Some("fragment2")).unwrap();
assert_eq!(url.fragment().unwrap(), "fragment2");
assert_eq!(url.to_string(), "#fragment2");

Trait Implementations

impl Clone for RelativeDIDUrl

fn clone(&self) -> RelativeDIDUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelativeDIDUrl

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

Formats the value using the given formatter.

impl Default for RelativeDIDUrl

fn default() -> RelativeDIDUrl

Returns the “default value” for a type.

impl Display for RelativeDIDUrl

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

Formats the value using the given formatter.

impl<'query> From<&'query RelativeDIDUrl> for DIDUrlQuery<'query>

fn from(other: &'query RelativeDIDUrl) -> DIDUrlQuery<'query>

Converts to this type from the input type.

impl Hash for RelativeDIDUrl

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RelativeDIDUrl

fn cmp(&self, other: &RelativeDIDUrl) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RelativeDIDUrl

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RelativeDIDUrl

fn partial_cmp(&self, other: &RelativeDIDUrl) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RelativeDIDUrl