Struct identity_iota::did::CoreDocument

pub struct CoreDocument<D = CoreDID, T = BTreeMap<String, Value, Global>, U = BTreeMap<String, Value, Global>, V = BTreeMap<String, Value, Global>> where
    D: DID + KeyComparable,  { /* private fields */ }

A DID Document.

Specification

Implementations

impl<D, T, U, V> CoreDocument<D, T, U, V> where
    D: DID + KeyComparable, 

pub fn builder(properties: T) -> DocumentBuilder<D, T, U, V>

Creates a DocumentBuilder to configure a new CoreDocument.

This is the same as DocumentBuilder::new.

pub fn from_builder(
    builder: DocumentBuilder<D, T, U, V>
) -> Result<CoreDocument<D, T, U, V>, Error>

Returns a new CoreDocument based on the DocumentBuilder configuration.

pub fn id(&self) -> &D

Returns a reference to the CoreDocument id.

pub fn id_mut(&mut self) -> &mut D

Returns a mutable reference to the CoreDocument id.

pub fn controller(&self) -> Option<&OneOrSet<D>>

Returns a reference to the CoreDocument controller.

pub fn controller_mut(&mut self) -> &mut Option<OneOrSet<D>>

Returns a mutable reference to the CoreDocument controller.

pub fn also_known_as(&self) -> &OrderedSet<Url>

Returns a reference to the CoreDocument alsoKnownAs set.

pub fn also_known_as_mut(&mut self) -> &mut OrderedSet<Url>

Returns a mutable reference to the CoreDocument alsoKnownAs set.

pub fn verification_method(&self) -> &OrderedSet<VerificationMethod<D, U>>

Returns a reference to the CoreDocument verificationMethod set.

pub fn verification_method_mut(
    &mut self
) -> &mut OrderedSet<VerificationMethod<D, U>>

Returns a mutable reference to the CoreDocument verificationMethod set.

pub fn authentication(&self) -> &OrderedSet<MethodRef<D, U>>

Returns a reference to the CoreDocument authentication set.

pub fn authentication_mut(&mut self) -> &mut OrderedSet<MethodRef<D, U>>

Returns a mutable reference to the CoreDocument authentication set.

pub fn assertion_method(&self) -> &OrderedSet<MethodRef<D, U>>

Returns a reference to the CoreDocument assertionMethod set.

pub fn assertion_method_mut(&mut self) -> &mut OrderedSet<MethodRef<D, U>>

Returns a mutable reference to the CoreDocument assertionMethod set.

pub fn key_agreement(&self) -> &OrderedSet<MethodRef<D, U>>

Returns a reference to the CoreDocument keyAgreement set.

pub fn key_agreement_mut(&mut self) -> &mut OrderedSet<MethodRef<D, U>>

Returns a mutable reference to the CoreDocument keyAgreement set.

pub fn capability_delegation(&self) -> &OrderedSet<MethodRef<D, U>>

Returns a reference to the CoreDocument capabilityDelegation set.

pub fn capability_delegation_mut(&mut self) -> &mut OrderedSet<MethodRef<D, U>>

Returns a mutable reference to the CoreDocument capabilityDelegation set.

pub fn capability_invocation(&self) -> &OrderedSet<MethodRef<D, U>>

Returns a reference to the CoreDocument capabilityInvocation set.

pub fn capability_invocation_mut(&mut self) -> &mut OrderedSet<MethodRef<D, U>>

Returns a mutable reference to the CoreDocument capabilityInvocation set.

pub fn service(&self) -> &OrderedSet<Service<D, V>>

Returns a reference to the CoreDocument service set.

pub fn service_mut(&mut self) -> &mut OrderedSet<Service<D, V>>

Returns a mutable reference to the CoreDocument service set.

pub fn properties(&self) -> &T

Returns a reference to the custom CoreDocument properties.

pub fn properties_mut(&mut self) -> &mut T

Returns a mutable reference to the custom CoreDocument properties.

pub fn map<S, C, F, G>(self, f: F, g: G) -> CoreDocument<C, S, U, V> where
    C: DID + KeyComparable,
    F: FnMut(D) -> C,
    G: FnOnce(T) -> S, 

Maps CoreDocument<D,T> to CoreDocument<C,U> by applying a function f to all DID fields and another function g to the custom properties.

pub fn try_map<S, C, F, G, E>(
    self,
    f: F,
    g: G
) -> Result<CoreDocument<C, S, U, V>, E> where
    C: DID + KeyComparable,
    F: FnMut(D) -> Result<C, E>,
    G: FnOnce(T) -> Result<S, E>, 

Fallible version of CoreDocument::map.

Errors

try_map can fail if either of the provided functions fail.

pub fn insert_method(
    &mut self,
    method: VerificationMethod<D, U>,
    scope: MethodScope
) -> Result<(), Error>

Adds a new VerificationMethod to the document in the given MethodScope.

Errors

Returns an error if a method with the same fragment already exists.

pub fn remove_method(&mut self, did: &DIDUrl<D>) -> Result<(), Error>

Removes all references to the specified VerificationMethod.

Errors

Returns an error if the method does not exist.

pub fn attach_method_relationship<'query, Q>(
    &mut self,
    method_query: Q,
    relationship: MethodRelationship
) -> Result<bool, Error> where
    Q: Into<DIDUrlQuery<'query>>, 

Attaches the relationship to the method resolved by method_query.

Errors

Returns an error if the method does not exist or if it is embedded. To convert an embedded method into a generic verification method, remove it first and insert it with MethodScope::VerificationMethod.

pub fn detach_method_relationship<'query, Q>(
    &mut self,
    method_query: Q,
    relationship: MethodRelationship
) -> Result<bool, Error> where
    Q: Into<DIDUrlQuery<'query>>, 

Detaches the relationship from the method resolved by method_query.

Errors

Returns an error if the method does not exist or is embedded. To remove an embedded method, use Self::remove_method.

pub fn methods(&self) -> impl Iterator<Item = &VerificationMethod<D, U>>

Returns an iterator over all embedded verification methods in the DID Document.

This excludes verification methods that are referenced by the DID Document.

pub fn verification_relationships(
    &self
) -> impl Iterator<Item = &MethodRef<D, U>>

Returns an iterator over all verification relationships.

This includes embedded and referenced VerificationMethods.

pub fn resolve_method<'query, Q>(
    &'me self,
    query: Q,
    scope: Option<MethodScope>
) -> Option<&'me VerificationMethod<D, U>> where
    Q: Into<DIDUrlQuery<'query>>, 

Returns the first VerificationMethod with an id property matching the provided query and the verification relationship specified by scope if present.

pub fn resolve_method_mut<'query, Q>(
    &'me mut self,
    query: Q,
    scope: Option<MethodScope>
) -> Option<&'me mut VerificationMethod<D, U>> where
    Q: Into<DIDUrlQuery<'query>>, 

Returns a mutable reference to the first VerificationMethod with an id property matching the provided query.

impl<D, T, U, V> CoreDocument<D, T, U, V> where
    D: DID + KeyComparable, 

pub fn verify_data<X>(
    &self,
    data: &X,
    options: &VerifierOptions
) -> Result<(), Error> where
    X: Serialize + GetSignature, 

Verifies the signature of the provided data.

Errors

Fails if an unsupported verification method is used, data serialization fails, or the verification operation fails.

impl<D, T, U, V> CoreDocument<D, T, U, V> where
    D: DID + KeyComparable, 

pub fn signer(
    &'base self,
    private: &'base Key<Private>
) -> DocumentSigner<'base, 'base, D, T, U, V>

Creates a new DocumentSigner that can be used to create digital signatures from verification methods in this DID Document.

Trait Implementations

impl<D, T, U, V> Clone for CoreDocument<D, T, U, V> where
    D: Clone + DID + KeyComparable,
    T: Clone,
    U: Clone,
    V: Clone, 

fn clone(&self) -> CoreDocument<D, T, U, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D, T, U, V> Debug for CoreDocument<D, T, U, V> where
    D: Debug + DID + KeyComparable,
    T: Debug,
    U: Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<'de, D, T, U, V> Deserialize<'de> for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable + Deserialize<'de>,
    T: Deserialize<'de>,
    U: Deserialize<'de>,
    V: Deserialize<'de>, 

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CoreDocument<D, T, U, V>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<D, T, U, V> Diff for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable + Diff + Serialize + for<'de> Deserialize<'de>,
    T: Diff + Serialize + for<'de> Deserialize<'de> + Default,
    U: Diff + Serialize + for<'de> Deserialize<'de> + Default,
    V: Diff + Serialize + for<'de> Deserialize<'de> + Default, 

type Type = DiffDocument<D, T, U, V>

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

The Corresponding Diff Type for the implemented Type.

fn diff(
    &self,
    other: &CoreDocument<D, T, U, V>
) -> Result<<CoreDocument<D, T, U, V> as Diff>::Type, Error>

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

Finds the difference between two types; self and other and returns Self::Type

fn merge(
    &self,
    diff: <CoreDocument<D, T, U, V> as Diff>::Type
) -> Result<CoreDocument<D, T, U, V>, Error>

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

Merges a Self::Type with Self

fn from_diff(
    diff: <CoreDocument<D, T, U, V> as Diff>::Type
) -> Result<CoreDocument<D, T, U, V>, Error>

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

Converts a diff of type Self::Type to a Self.

fn into_diff(self) -> Result<<CoreDocument<D, T, U, V> as Diff>::Type, Error>

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

Converts a type of Self to a diff of Self::Type.

impl<D, T, U, V> Display for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable + Serialize,
    T: Serialize,
    U: Serialize,
    V: Serialize, 

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

Formats the value using the given formatter.

impl From<IotaDocument> for CoreDocument<IotaDID, BTreeMap<String, Value, Global>, BTreeMap<String, Value, Global>, BTreeMap<String, Value, Global>>

fn from(
    document: IotaDocument
) -> CoreDocument<IotaDID, BTreeMap<String, Value, Global>, BTreeMap<String, Value, Global>, BTreeMap<String, Value, Global>>

Converts to this type from the input type.

impl<D, T, U, V> PartialEq<CoreDocument<D, T, U, V>> for CoreDocument<D, T, U, V> where
    D: PartialEq<D> + DID + KeyComparable,
    T: PartialEq<T>,
    U: PartialEq<U>,
    V: PartialEq<V>, 

fn eq(&self, other: &CoreDocument<D, T, U, V>) -> bool

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

fn ne(&self, other: &CoreDocument<D, T, U, V>) -> bool

This method tests for !=.

impl<D, T, U, V> Serialize for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable + Serialize,
    T: Serialize,
    U: Serialize,
    V: Serialize, 

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<D, T, U, V> TryMethod for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable, 

const TYPE: MethodUriType = MethodUriType::Relative

Flag that determines whether absolute or rleative URI

fn method<D, U>(method: &VerificationMethod<D, U>) -> Option<String> where
    D: DID, 

Returns an absolute or relative method URI, if any, depending on the MethodUriType.

fn try_method<D, U>(method: &VerificationMethod<D, U>) -> Result<String, Error> where
    D: DID, 

Returns String representation of absolute or relative method URI.

impl<D, T, U, V> StructuralPartialEq for CoreDocument<D, T, U, V> where
    D: DID + KeyComparable,