Struct DIDUrl

pub struct DIDUrl { /* private fields */ }

A DID Url: a CoreDID with RelativeDIDUrl components.

E.g. “did:iota:H3C2AVvLMv6gmMNam3uVAjZar3cJCwDwnZn6z3wXmqPV/path?query1=a&query2=b#fragment”

Implementations

impl DIDUrl

pub fn new(did: CoreDID, url: Option<RelativeDIDUrl>) -> Self

Construct a new DIDUrl with optional RelativeDIDUrl.

pub fn parse(input: impl AsRef<str>) -> Result<Self, Error>

Parse a DIDUrl from a string.

pub fn did(&self) -> &CoreDID

Returns the did.

pub fn url(&self) -> &RelativeDIDUrl

Returns the RelativeDIDUrl.

pub fn set_url(&mut self, url: RelativeDIDUrl)

Sets the RelativeDIDUrl.

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

Returns the DIDUrl fragment component.

See RelativeDIDUrl::fragment.

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

Sets the fragment component of the DIDUrl.

See RelativeDIDUrl::set_fragment.

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

Returns the DIDUrl path component.

See RelativeDIDUrl::path.

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

Sets the path component of the DIDUrl.

See RelativeDIDUrl::set_path.

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

Returns the DIDUrl query component.

See RelativeDIDUrl::query.

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

Sets the query component of the DIDUrl.

See RelativeDIDUrl::set_query.

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

Parses the DIDUrl query and returns an iterator of (key, value) pairs.

See RelativeDIDUrl::query_pairs.

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

Append a string representing a path, query, and/or fragment, returning a new DIDUrl.

Must begin with a valid delimiter character: ‘/’, ‘?’, ‘#’. Overwrites the existing URL segment and any following segments in order of path, query, then fragment.

I.e.

• joining a path will overwrite the path and clear the query and fragment.
• joining a query will overwrite the query and clear the fragment.
• joining a fragment will only overwrite the fragment.

pub fn map<F>(self, f: F) -> DIDUrl

where F: FnOnce(CoreDID) -> CoreDID,

Maps a DIDUrl by applying a function to the CoreDID part of the DIDUrl, the RelativeDIDUrl components are left untouched.

pub fn try_map<F, E>(self, f: F) -> Result<DIDUrl, E>

where F: FnOnce(CoreDID) -> Result<CoreDID, E>,

Fallible version of DIDUrl::map.

Trait Implementations

impl AsRef<CoreDID> for DIDUrl

fn as_ref(&self) -> &CoreDID

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DIDUrl> for DIDUrl

fn as_ref(&self) -> &DIDUrl

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DIDUrl

fn clone(&self) -> DIDUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DIDUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DIDUrl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DIDUrl

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

Formats the value using the given formatter.

impl<D> From<D> for DIDUrl

where D: Into<CoreDID>,

fn from(did: D) -> Self

Converts to this type from the input type.

impl From<DIDUrl> for String

fn from(did_url: DIDUrl) -> Self

Converts to this type from the input type.

impl From<DIDUrl> for Url

fn from(did_url: DIDUrl) -> Self

Converts to this type from the input type.

impl FromStr for DIDUrl

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for DIDUrl

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 KeyComparable for DIDUrl

type Key = DIDUrl

Key type for comparisons.

fn key(&self) -> &Self::Key

Returns a reference to the key.

impl Ord for DIDUrl

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

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

fn partial_cmp(&self, other: &Self) -> 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 DIDUrl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for DIDUrl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DIDUrl