Struct Uri 

pub struct Uri(/* private fields */);

A URI (RFC 3986) stored exactly as written: no normalization, no percent-decoding, no case folding.

DID documents carry URIs in alsoKnownAs and serviceEndpoint, and DID Core requires a consumer to hand them on unchanged, so this type checks the generic syntax and nothing more: a scheme, then characters from the RFC 3986 sets (unreserved, reserved, pct-encoded), with at most one #. Two URIs are equal exactly when their strings are equal.

Every Did and DidUrl is a Uri; use From to convert.

Examples

use identity_kit::did::Uri;

let uri = Uri::parse("https://bar.example.com")?;
assert_eq!(uri.as_str(), "https://bar.example.com"); // no trailing slash added
assert_eq!(uri.scheme(), "https");

assert!(Uri::parse("not a uri").is_err());
assert!(Uri::parse("/relative/path").is_err());

Implementations

impl Uri

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

Parses a URI, checking the RFC 3986 generic syntax.

Errors

DidError::InvalidChar names the first byte that is not allowed in a URI, including a missing or malformed scheme; DidError::InvalidPercentEncoding an incomplete %xx.

pub fn as_str(&self) -> &str

The URI as written.

pub fn scheme(&self) -> &str

The scheme, without the :.

pub fn is_did_url(&self) -> bool

Whether this URI is a DID or a DID URL.

Trait Implementations

impl AsRef<str> for Uri

fn as_ref(&self) -> &str

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

impl Clone for Uri

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 Uri

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Uri

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

Deserialize this value from the given Serde deserializer.

impl Display for Uri

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

Formats the value using the given formatter.

impl Eq for Uri

impl From<&Did> for Uri

fn from(did: &Did) -> Self

Converts to this type from the input type.

impl From<&DidUrl> for Uri

fn from(url: &DidUrl) -> Self

Converts to this type from the input type.

impl From<Did> for Uri

fn from(did: Did) -> Self

Converts to this type from the input type.

impl From<DidUrl> for Uri

fn from(url: DidUrl) -> Self

Converts to this type from the input type.

impl From<Uri> for ServiceEndpoint

fn from(uri: Uri) -> Self

Converts to this type from the input type.

impl From<Uri> for Party

Available on crate feature vc only.

fn from(id: Uri) -> Self

Converts to this type from the input type.

impl FromStr for Uri

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 Uri

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 Uri

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 Uri

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Uri

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Uri

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Uri

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 Uri

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Uri

impl TryFrom<&str> for Uri

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 Uri

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.