Struct VerificationMethod 

#[non_exhaustive]
pub struct VerificationMethod {
    pub id: DidUrl,
    pub method_type: MethodType,
    pub controller: Did,
    pub material: VerificationMaterial,
    pub properties: IndexMap<String, Value>,
}

A verification method (DID Core §5.2): a public key with an id, a type and a controller.

Members other than the four core ones live in properties, in insertion order.

Examples

use identity_kit::did::{MethodType, VerificationMaterial, VerificationMethod};

let json = r#"{
  "id": "did:example:123#key-1",
  "type": "Multikey",
  "controller": "did:example:123",
  "publicKeyMultibase": "z6MkmM42vxfqZQsv4ehtTjFFxQ4sQKS2w6WR7emozFAn5cxu"
}"#;
let method: VerificationMethod = serde_json::from_str(json)?;
assert_eq!(method.method_type, MethodType::MULTIKEY);
assert_eq!(method.controller.as_str(), "did:example:123");
assert_eq!(
    method.material.as_multibase(),
    Some("z6MkmM42vxfqZQsv4ehtTjFFxQ4sQKS2w6WR7emozFAn5cxu")
);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: DidUrl

The DID URL identifying the method, usually the document DID with a fragment.

method_type: MethodType

The type, which tells which cryptographic suite reads the material.

controller: Did

The DID of the controller of the key.

material: VerificationMaterial

publicKeyJwk or publicKeyMultibase.

properties: IndexMap<String, Value>

Every other member, in insertion order.

Implementations

impl VerificationMethod

pub fn new( id: DidUrl, method_type: MethodType, controller: Did, material: VerificationMaterial, ) -> Self

A verification method with the four core members.

pub fn public_key_jwk(&self) -> Option<&Jwk>

The publicKeyJwk, if that is the material.

pub fn public_key_multibase(&self) -> Option<&str>

The publicKeyMultibase, if that is the material.

Trait Implementations

impl Clone for VerificationMethod

fn clone(&self) -> Self

Returns a duplicate 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VerificationMethod

impl From<VerificationMethod> for MethodRef

fn from(method: VerificationMethod) -> Self

Converts to this type from the input type.

impl PartialEq for VerificationMethod

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for VerificationMethod

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for VerificationMethod

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VerificationMethod

impl ToSchema for VerificationMethod

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.