Struct DID

pub struct DID {
    pub name: Vec<u8>,
    pub id: Vec<u8>,
}

A DID is a decentralized identity according to https://www.w3.org/TR/did-core/#did-syntax. A DID internally is represented as a byte array that is percent-encoded on demand according to the rules defined in that document, as well as validated in some instances with regards to encoding requirements. DIDs are not required to be UTF-8 compliant in the ID portion, and all bytes that fall outside of a normal alphanumeric ASCII range are percent-encoded, with a few exceptions. The internal types are Vec<u8> for malleability but this may change to [u8] in the future.

DIDs must have both a non-empty name and ID portion according to this interpretation of the spec. They must start with did: and will be generated as such both in string conversion and serialization steps. De-serialization also runs through the same checks and conversions.

use did_toolkit::prelude::*;

let did = DID::parse("did:mymethod:alice").unwrap();
assert_eq!(String::from_utf8(did.name).unwrap(), "mymethod");
assert_eq!(String::from_utf8(did.id).unwrap(), "alice");

let did = DID {
    name: "mymethod".as_bytes().to_vec(),
    id: "alice".as_bytes().to_vec(),
};
assert_eq!(did.to_string(), "did:mymethod:alice");

Fields

name: Vec<u8>

id: Vec<u8>

Implementations

impl DID

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

Parse a DID from a string. See top-level type documentation for information on formats.

pub fn join(&self, parameters: URLParameters) -> URL

When provided with URL parameters, generates a DID URL. These are different from hypertext URLs and should be handled differently.

use did_toolkit::prelude::*;

let did = DID::parse("did:mymethod:alice").unwrap();
let url = did.join(URLParameters{
    fragment: Some("key-1".as_bytes().to_vec()),
    ..Default::default()
});
assert_eq!(url.to_string(), "did:mymethod:alice#key-1");

Trait Implementations

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

Formats the value using the given formatter.

impl Default for DID

fn default() -> DID

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DID

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

Formats the value using the given formatter.

impl Hash for DID

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<'a> Index<&'a DID> for Registry

type Output = Document

The returned type after indexing.

fn index(&self, index: &'a DID) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<&'a DID> for Registry

fn index_mut(&mut self, index: &'a DID) -> &mut Document

Performs the mutable indexing (container[index]) operation.

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 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::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DID

impl StructuralPartialEq for DID