Struct URL

pub struct URL {
    pub did: DID,
    pub parameters: Option<URLParameters>,
}

DID URL handling, including parsing, (de)-serialization, and manipulation according to https://www.w3.org/TR/did-core/#did-url-syntax.

DID URLs are nothing like hypertext URLs and it is strongly cautioned that you do not treat them as such.

The struct includes a DID as well as optional URLParameters to extend the DID. Converting to string, formatting for display, or serialization will cause the URL to be generated.

use did_toolkit::prelude::*;

let url = URL::parse("did:mymethod:alice/path?service=foo#fragment").unwrap();
assert_eq!(url, URL {
    did: DID::parse("did:mymethod:alice").unwrap(),
    parameters: Some(URLParameters{
        path: Some("path".as_bytes().to_vec()),
        fragment: Some("fragment".as_bytes().to_vec()),
        service: Some("foo".to_string()),
        ..Default::default()
    })
});
let url = URL {
    did: DID::parse("did:mymethod:bob").unwrap(),
    parameters: Some(URLParameters{
        path: Some("path".as_bytes().to_vec()),
        fragment: Some("fragment".as_bytes().to_vec()),
        service: Some("bar".to_string()),
        version_id: Some("1.0".to_string()),
        ..Default::default()
    })
};

assert_eq!(url.to_string(), "did:mymethod:bob/path?service=bar&versionId=1.0#fragment");

Fields

did: DID

parameters: Option<URLParameters>

Implementations

impl URL

pub fn parse(s: &str) -> Result<Self, Error>

Parse a DID URL from string. See URL for more information.

pub fn join(&self, s: &str) -> Result<Self, Error>

Parse and join a DID URL. If you want to join a URL from URLParameters, see DID::join.

pub fn to_did(&self) -> DID

Converts to the underlying DID.

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

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

Formats the value using the given formatter.

impl Hash for URL

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

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 URL

fn cmp(&self, other: &URL) -> 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 URL

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

fn partial_cmp(&self, other: &URL) -> 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 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 Eq for URL

impl StructuralPartialEq for URL