Struct Document

pub struct Document {
    pub context: Option<Context>,
    pub id: DID,
    pub also_known_as: Option<AlsoKnownAs>,
    pub controller: Option<Controller>,
    pub verification_method: Option<BTreeSet<VerificationMethod>>,
    pub authentication: Option<VerificationMethods>,
    pub assertion_method: Option<VerificationMethods>,
    pub key_agreement: Option<VerificationMethods>,
    pub capability_invocation: Option<VerificationMethods>,
    pub capability_delegation: Option<VerificationMethods>,
    pub service: Option<BTreeSet<ServiceEndpoint>>,
}

The encapsulation of a decentralized identity document, or DID. This conforms to the did-core spec in totality, according to the rules defined in https://www.w3.org/TR/did-core/#core-properties. Divergence from the spec will be considered a bug, unless otherwise noted.

Please see the individual properties regarding their use. Types in this module will remain undocumented for brevity’s sake, with the exception of methods that live on those types.

One notable thing in this implementation is use of the either crate with wrapping types. This is used to aid in the (de)-serialization of documents properties that can consume multiple switched types. Unfortunately, the spec is not very kind to users of statically-typed languages, so we must take extra precautions to ensure all valid documents can be parsed. To utilize most of these types, there may be an “either wrapper” as well as the either::Either enum itself to encapsulate a type. For example, AlsoKnownAs encapsulates AlsoKnownAsEither as a BTreeSet which then encapsulates either::Either types depending on which style of attribute was used, as DIDs and hypertext url::Urls can be used interchangeably. This approach reduces memory usage and computation time by storing structs instead of raw strings and “figuring it out later”.

JSON-LD attributes (@context, specifically), are accounted for but not used by this implementation. This allows you to generate documents and consume ones that follow the JSON-LD specification but does not attempt to validate the document using the JSON-LD schema. See the crate’s README for more information regarding this decision.

serde crate implementations are available for all types, to ensure valid serde_json and ciborium I/O, but other formats that serde supports should be technically possible to support without issue.

Fields

context: Option<Context>

JSON-LD @context support

id: DID

The DID that this document corresponds to. Will be used as the key when storing in a Registry. This is called the “DID Subject” in the specification.

also_known_as: Option<AlsoKnownAs>

alsoKnownAs determines equivalence for two documents for all purposes. See https://www.w3.org/TR/did-core/#also-known-as for more.

controller: Option<Controller>

verification_method: Option<BTreeSet<VerificationMethod>>

VerificationMethods are used to verify the identity claiming this document. See https://www.w3.org/TR/did-core/#verification-methods for more. Most following properties that use VerificationMethods may refer to this portion of the document by URL to add additional capabilities to a specific VerificationMethod.

authentication: Option<VerificationMethods>

This set of VerificationMethods corresponds to authentication. https://www.w3.org/TR/did-core/#authentication

assertion_method: Option<VerificationMethods>

This set of VerificationMethods corresponds to assertions. https://www.w3.org/TR/did-core/#assertion

key_agreement: Option<VerificationMethods>

This set of VerificationMethods refers to key agreement. https://www.w3.org/TR/did-core/#key-agreement

capability_invocation: Option<VerificationMethods>

This set of VerificationMethods refers to capability invocation. https://www.w3.org/TR/did-core/#capability-invocation This set of VerificationMethods refers to capability delegation. https://www.w3.org/TR/did-core/#capability-delegation

capability_delegation: Option<VerificationMethods>

service: Option<BTreeSet<ServiceEndpoint>>

This portion of the document refers to affected services. Services are specially provided by the “DID registry”: https://www.w3.org/TR/did-spec-registries/ and rely on enums to determine how the service is treated.

Implementations

impl Document

pub fn valid(&self, registry: Option<&Registry>) -> Result<(), Error>

Determines if a document is valid. Takes an optional registry to resolve URLs

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Document

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 Document

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 Document

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

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 Document

impl StructuralPartialEq for Document