Enum DidUrlReference 

pub enum DidUrlReference {
    Absolute(DidUrl),
    Relative(String),
}

A reference to a resource of a DID document: either an absolute DidUrl or a relative DID URL (DID Core §3.2.2) such as #key-1, which is resolved against the document’s id.

Verification relationships reference verification methods this way, and a document may use either form, so the reference keeps whichever it was given and resolve turns it into an absolute DID URL when a base DID is known.

A relative reference is a path, query and fragment (any of them, in that order), so it starts with /, ? or #.

Examples

use identity_kit::did::{Did, DidUrlReference};

let base: Did = "did:example:123".parse()?;

let relative = DidUrlReference::parse("#key-1")?;
assert!(relative.is_relative());
assert_eq!(relative.resolve(&base)?.as_str(), "did:example:123#key-1");

let absolute = DidUrlReference::parse("did:example:456#key-1")?;
assert!(!absolute.is_relative());
assert_eq!(absolute.resolve(&base)?.as_str(), "did:example:456#key-1");

Variants

Absolute(DidUrl)

A DID URL.

Relative(String)

A relative DID URL: /path, ?query or #fragment, possibly combined, as written.

Implementations

impl DidUrlReference

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

Parses a DID URL or a relative DID URL, rejecting input longer than DEFAULT_MAX_LEN bytes.

Errors

A DidError when the input is neither a valid DID URL nor a relative reference starting with /, ? or # whose components are valid per RFC 3986. Positions in the error are byte offsets into the input.

pub fn is_relative(&self) -> bool

Whether this is a relative reference.

pub fn as_str(&self) -> &str

The reference as written.

pub fn resolve(&self, base: &Did) -> Result<DidUrl, DidError>

The absolute DID URL, resolving a relative reference against base as RFC 3986 §5 prescribes for a DID document (DID Core §3.2.2).

Errors

DidError::TooLong when base and a relative reference together exceed DEFAULT_MAX_LEN bytes, the limit Did::join keeps to.

pub fn refers_to(&self, url: &DidUrl, base: &Did) -> bool

Whether this reference denotes url in a document whose id is base.

Trait Implementations

impl AsRef<str> for DidUrlReference

fn as_ref(&self) -> &str

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

impl Clone for DidUrlReference

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DidUrlReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DidUrlReference

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for DidUrlReference

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

Formats the value using the given formatter.

impl Eq for DidUrlReference

impl From<&DidUrl> for DidUrlReference

fn from(url: &DidUrl) -> Self

Converts to this type from the input type.

impl From<DidUrl> for DidUrlReference

fn from(url: DidUrl) -> Self

Converts to this type from the input type.

impl From<DidUrlReference> for MethodRef

fn from(reference: DidUrlReference) -> Self

Converts to this type from the input type.

impl FromStr for DidUrlReference

type Err = DidError

The associated error which can be returned from parsing.

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

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

impl Hash for DidUrlReference

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 DidUrlReference

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for DidUrlReference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DidUrlReference

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 DidUrlReference

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DidUrlReference

impl TryFrom<&str> for DidUrlReference

type Error = DidError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for DidUrlReference

type Error = DidError

The type returned in the event of a conversion error.

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

Performs the conversion.