Struct identity_iota::verification::VerificationMethod

pub struct VerificationMethod { /* private fields */ }

A DID Document Verification Method.

Specification

Implementations

impl VerificationMethod

pub fn builder(properties: BTreeMap<String, Value>) -> MethodBuilder

Creates a MethodBuilder to configure a new Method.

This is the same as MethodBuilder::new().

pub fn from_builder(builder: MethodBuilder) -> Result<VerificationMethod, Error>

Returns a new Method based on the MethodBuilder configuration.

pub fn id(&self) -> &DIDUrl

Returns a reference to the VerificationMethod id.

pub fn set_id(&mut self, id: DIDUrl) -> Result<(), Error>

Sets the VerificationMethod id.

Errors

Error::MissingIdFragment if there is no fragment on the DIDUrl.

pub fn controller(&self) -> &CoreDID

Returns a reference to the VerificationMethod controller.

pub fn controller_mut(&mut self) -> &mut CoreDID

Returns a mutable reference to the VerificationMethod controller.

pub fn type_(&self) -> &MethodType

Returns a reference to the VerificationMethod type.

pub fn type_mut(&mut self) -> &mut MethodType

Returns a mutable reference to the VerificationMethod type.

pub fn data(&self) -> &MethodData

Returns a reference to the VerificationMethod data.

pub fn data_mut(&mut self) -> &mut MethodData

Returns a mutable reference to the VerificationMethod data.

pub fn properties(&self) -> &BTreeMap<String, Value>

Returns a reference to the custom VerificationMethod properties.

pub fn properties_mut(&mut self) -> &mut BTreeMap<String, Value>

Returns a mutable reference to the custom VerificationMethod properties.

pub fn into_method_ref(self) -> MethodRef

Creates a new MethodRef from self.

pub fn map<F>(self, f: F) -> VerificationMethod

where F: FnMut(CoreDID) -> CoreDID,

Maps the VerificationMethod by applying a function f to the CoreDID components of id and controller. Useful when working with DID methods where the identifier is not known before publishing.

pub fn try_map<F, E>(self, f: F) -> Result<VerificationMethod, E>

where F: FnMut(CoreDID) -> Result<CoreDID, E>,

Fallible version of VerificationMethod::map.

impl VerificationMethod

pub fn new_from_jwk<D>( did: D, key: Jwk, fragment: Option<&str> ) -> Result<VerificationMethod, Error>

where D: DID,

Creates a new VerificationMethod from the given did and Jwk. If fragment is not given the kid value of the given key will be used, if present, otherwise an error is returned.

Recommendations

The following recommendations are essentially taken from the publicKeyJwk description from the DID specification:

• It is recommended that verification methods that use Jwks to represent their public keys use the value of kid as their fragment identifier. This is done automatically if None is passed in as the fragment.
• It is recommended that Jwk kid values are set to the public key fingerprint. See Jwk::thumbprint_sha256_b64.

Trait Implementations

impl AsRef<DIDUrl> for VerificationMethod

fn as_ref(&self) -> &DIDUrl

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VerificationMethod

fn clone(&self) -> VerificationMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationMethod

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VerificationMethod

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VerificationMethod

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

Formats the value using the given formatter.

impl From<VerificationMethod> for MethodRef

fn from(other: VerificationMethod) -> MethodRef

Converts to this type from the input type.

impl From<_VerificationMethod> for VerificationMethod

fn from(value: _VerificationMethod) -> VerificationMethod

Converts to this type from the input type.

impl KeyComparable for VerificationMethod

type Key = DIDUrl

Key type for comparisons.

fn key(&self) -> &<VerificationMethod as KeyComparable>::Key

Returns a reference to the key.

impl PartialEq for VerificationMethod

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

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 VerificationMethod

impl StructuralPartialEq for VerificationMethod