Struct ssi_dids_core::document::Document

pub struct Document {
    pub id: DIDBuf,
    pub also_known_as: Vec<IriBuf>,
    pub verification_relationships: VerificationRelationships,
    pub controller: Option<OneOrMany<DIDBuf>>,
    pub verification_method: Vec<DIDVerificationMethod>,
    pub public_key: Vec<DIDVerificationMethod>,
    pub service: Vec<Service>,
    pub property_set: BTreeMap<String, Value>,
}

A DID document

Fields

id: DIDBuf

DID subject identifier.

See: https://www.w3.org/TR/did-core/#did-subject

also_known_as: Vec<IriBuf>

Other URIs for the DID subject.

See: https://www.w3.org/TR/did-core/#also-known-as

verification_relationships: VerificationRelationships

Verification relationships.

Properties that express the relationship between the DID subject and a verification method using a verification relationship.

See: https://www.w3.org/TR/did-core/#verification-relationships

controller: Option<OneOrMany<DIDBuf>>

Controllers(s).

See: https://www.w3.org/TR/did-core/#did-controller

verification_method: Vec<DIDVerificationMethod>

verificationMethod property of a DID document, expressing verification methods.

public_key: Vec<DIDVerificationMethod>

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

service: Vec<Service>

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

property_set: BTreeMap<String, Value>

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

Implementations

impl Document

pub fn new(id: DIDBuf) -> Document

Construct a new DID document with the given id (DID).

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

Construct a DID document from JSON.

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

Construct a DID document from JSON bytes.

pub fn from_bytes( type_: MediaType, bytes: &[u8], ) -> Result<Represented, InvalidData>

pub fn find_resource(&self, id: &DIDURL) -> Option<ResourceRef<'_>>

Select an object in the DID document.

See: https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm-secondary

pub fn into_resource(self, id: &DIDURL) -> Option<Resource>

Select an object in the DID document.

See: https://w3c-ccg.github.io/did-resolution/#dereferencing-algorithm-secondary

pub fn service(&self, id: &str) -> Option<&Service>

Returns the service with the given id, if any.

pub fn into_representation(self, options: Options) -> Represented

pub fn into_any_verification_method(self) -> Option<DIDVerificationMethod>

Consumes the document and returns any verification method in contains.

This will return the first verification method found, although users should not expect the DID documents to always list verification methods in the same order.

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

fn allows_verification_method( &self, id: &Iri, proof_purposes: ProofPurposes, ) -> bool

Checks that the controller allows using the verification method for the given proof purposes.

impl Debug for Document

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

Formats the value using the given formatter.

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

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