Struct didkit::Document

pub struct Document {

    pub context: Contexts,
    pub id: String,
    pub also_known_as: Option<Vec<String, Global>>,
    pub controller: Option<OneOrMany<String>>,
    pub verification_method: Option<Vec<VerificationMethod, Global>>,
    pub authentication: Option<Vec<VerificationMethod, Global>>,
    pub assertion_method: Option<Vec<VerificationMethod, Global>>,
    pub key_agreement: Option<Vec<VerificationMethod, Global>>,
    pub capability_invocation: Option<Vec<VerificationMethod, Global>>,
    pub capability_delegation: Option<Vec<VerificationMethod, Global>>,
    pub public_key: Option<Vec<VerificationMethod, Global>>,
    pub service: Option<Vec<Service, Global>>,
    pub proof: Option<OneOrMany<Proof>>,
    pub property_set: Option<BTreeMap<String, Value, Global>>,
}

A DID document

Fields

context: Contexts

@context property of a DID document.

id: String

DID Subject id

also_known_as: Option<Vec<String, Global>>

alsoKnownAs property of a DID document, expressing other URIs for the DID subject.

controller: Option<OneOrMany<String>>

controller property of a DID document, expressing DID controllers(s).

verification_method: Option<Vec<VerificationMethod, Global>>

verificationMethod property of a DID document, expressing verification methods.

authentication: Option<Vec<VerificationMethod, Global>>

authentication property of a DID document, expressing verification methods for authentication purposes (e.g. generating [verifiable presentations][crate::vc::Presentation]).

assertion_method: Option<Vec<VerificationMethod, Global>>

assertionMethod property of a DID document, expressing verification methods for assertion purposes (e.g. issuing verifiable credentials).

key_agreement: Option<Vec<VerificationMethod, Global>>

keyAgreement property of a DID document, expressing verification methods for key agreement purposes.

capability_invocation: Option<Vec<VerificationMethod, Global>>

capabilityInvocation property of a DID document, expressing verification methods for invoking cryptographic capabilities.

capability_delegation: Option<Vec<VerificationMethod, Global>>

capabilityDelegation property of a DID document, expressing verification methods for delegating cryptographic capabilities.

public_key: Option<Vec<VerificationMethod, Global>>

publicKey property of a DID document (deprecated in favor of verificationMethod).

service: Option<Vec<Service, Global>>

service property of a DID document, expressing services, generally as endpoints.

proof: Option<OneOrMany<Proof>>

Linked data proof over a DID document.

property_set: Option<BTreeMap<String, Value, Global>>

Additional properties of a DID document. Some may be registered in DID Specification Registries.

Implementations

impl Document

pub fn new(id: &str) -> Document

Construct a new DID document with the given id (DID) and [default @context][DEFAULT_CONTEXT].

pub fn from_json(json: &str) -> Result<Document, Error>

Construct a DID document from JSON.

pub fn from_json_bytes(json: &[u8]) -> Result<Document, Error>

Construct a DID document from JSON bytes.

pub fn select_object(&self, id: &DIDURL) -> Result<Resource, Error>

Select an object in the DID document.

Used in DID URL dereferencing - Dereferencing the Secondary Resource, Step 1.1 “… select the JSON-LD object whose id property matches the input DID URL …”

pub fn select_service(&self, fragment: &str) -> Option<&Service>

Select a service endpoint object in the DID document.

Used in DID URL Dereferencing - Dereferencing the Primary Resource, Step 1.1 “… select the service endpoint whose id property contains a fragment which matches the value of the service DID parameter of the input DID URL”

pub fn get_verification_method_ids( &self, verification_relationship: VerificationRelationship ) -> Result<Vec<String, Global>, String>

Get verification method ids from a DID document, optionally limited to a specific verification relationship.

pub fn to_representation( &self, content_type: &str ) -> Result<Vec<u8, Global>, Error>

Serialize a DID document with a given representation identified by a content-type string.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Create a new DID document with an empty string as the id. The empty string is not valid as a DID, so this should be changed immediately.

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

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Document> for Document

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Document

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 Eq for Document

impl StructuralEq for Document

impl StructuralPartialEq for Document