Struct MethodCapabilities 

#[non_exhaustive]
pub struct MethodCapabilities {
    pub updatable: bool,
    pub hosting: Hosting,
    pub single_key: bool,
    pub fixed_fragment: Option<&'static str>,
}

What a DID method can do, declared by its DidProducer so an application can pick a method without knowing it.

Examples

use identity_kit::resolver::{Hosting, MethodCapabilities};

// did:jwk: one key, no updates, the method is always `#0`.
let jwk = MethodCapabilities::new(Hosting::Embedded)
    .with_single_key(true)
    .with_fixed_fragment("0");
assert!(!jwk.updatable);
assert_eq!(jwk.fixed_fragment, Some("0"));

// did:web: any number of keys, updated by republishing the document.
let web = MethodCapabilities::new(Hosting::Web).with_updatable(true);
assert!(web.updatable && !web.single_key && web.fixed_fragment.is_none());

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.

updatable: bool

Whether a document can change after creation. An embedded method never can.

hosting: Hosting

Where the documents live.

single_key: bool

Whether a document holds exactly one verification method.

fixed_fragment: Option<&'static str>

The fragment every verification method of the method is named with (0 for did:jwk), or None when the fragment depends on the key or on the caller.

Implementations

impl MethodCapabilities

pub const fn new(hosting: Hosting) -> Self

Capabilities of a method hosted as hosting: not updatable, any number of keys, no fixed fragment.

pub const fn with_updatable(self, updatable: bool) -> Self

These capabilities with updatable set.

pub const fn with_single_key(self, single_key: bool) -> Self

These capabilities with single_key set.

pub const fn with_fixed_fragment(self, fragment: &'static str) -> Self

These capabilities with fixed_fragment set.

Trait Implementations

impl Clone for MethodCapabilities

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 MethodCapabilities

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

Formats the value using the given formatter.

impl Eq for MethodCapabilities

impl Hash for MethodCapabilities

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MethodCapabilities

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MethodCapabilities