Struct BaseDIDUrl

pub struct BaseDIDUrl { /* private fields */ }

A Decentralized Identifier (DID).

More Info (W3C DID Core)

Implementations

impl DID

pub const SCHEME: &'static str = "did"

The URL scheme for Decentralized Identifiers.

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

Parses a DID from the provided input.

Errors

Returns Err if any DID segments are invalid.

pub const fn inspect(&self) -> Inspect<'_>

Returns a wrapped DID with a more detailed Debug implementation.

pub fn as_str(&self) -> &str

Returns the serialized DID.

This is fast since the serialized value is stored in the DID.

pub fn into_string(self) -> String

Consumes the DID and returns the serialization.

pub const fn scheme(&self) -> &'static str

Returns the DID scheme. See DID::SCHEME.

pub fn authority(&self) -> &str

Returns the DID authority.

pub fn method(&self) -> &str

Returns the DID method name.

pub fn method_id(&self) -> &str

Returns the DID method-specific ID.

pub fn path(&self) -> &str

Returns the DID path.

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

Returns the DID method query, if any.

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

Returns the DID method fragment, if any.

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

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

pub fn set_method(&mut self, value: impl AsRef<str>)

Change the method of the DID.

pub fn set_method_id(&mut self, value: impl AsRef<str>)

Change the method-specific-id of the DID.

pub fn set_path(&mut self, value: impl AsRef<str>)

Change the path of the DID.

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

Change the query of the DID.

No serialization is performed.

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

Change the fragment of the DID.

No serialization is performed.

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

Creates a new DID by joining self with the relative DID other.

Errors

Returns Err if any base or relative DID segments are invalid.

Trait Implementations

impl AsRef<str> for DID

fn as_ref(&self) -> &str

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

impl Clone for DID

fn clone(&self) -> DID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DID

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DID

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

Formats the value using the given formatter.

impl From<CoreDID> for DID

fn from(did: CoreDID) -> Self

Converts to this type from the input type.

impl FromStr for DID

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<DID, <DID as FromStr>::Err>

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

impl Hash for DID

fn hash<H>(&self, hasher: &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 DID

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

fn eq(&self, other: &&str) -> 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 PartialEq<str> for DID

fn eq(&self, other: &str) -> 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 PartialEq for DID

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DID> for CoreDID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(base_did_url: BaseDIDUrl) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for DID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: String) -> Result<DID, <DID as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for DID