Struct ResolutionResult 

#[non_exhaustive]
pub struct ResolutionResult {
    pub document: Option<DidDocument>,
    pub resolution_metadata: ResolutionMetadata,
    pub document_metadata: DocumentMetadata,
}

What a resolver returns: the document when resolution succeeded, and the two metadata structures (DID Core §7.1.1).

Examples

use identity_kit::did::{ResolutionErrorKind, ResolutionResult};

let failed = ResolutionResult::error(ResolutionErrorKind::NotFound);
assert_eq!(
    serde_json::to_string(&failed)?,
    r#"{"didResolutionMetadata":{"error":"notFound"},"didDocumentMetadata":{}}"#
);
assert_eq!(failed.into_document().unwrap_err(), ResolutionErrorKind::NotFound);

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.

document: Option<DidDocument>

The DID document, absent when resolution failed.

resolution_metadata: ResolutionMetadata

Metadata about the resolution process.

document_metadata: DocumentMetadata

Metadata about the document.

Implementations

impl ResolutionResult

pub fn new(document: DidDocument) -> Self

A successful result holding document.

pub fn error(error: impl Into<ResolutionError>) -> Self

A failed result reporting error, a ResolutionError or a bare ResolutionErrorKind.

pub fn with_document_metadata(self, metadata: DocumentMetadata) -> Self

This result with document_metadata.

pub fn with_resolution_metadata(self, metadata: ResolutionMetadata) -> Self

This result with resolution_metadata.

pub fn error_kind(&self) -> Option<&ResolutionErrorKind>

The keyword of the reported error, if any; the error itself, with its detail and source, is in resolution_metadata.

pub fn into_document(self) -> Result<DidDocument, ResolutionError>

The document, or the reported error; a result with neither counts as ResolutionErrorKind::NotFound.

Errors

The ResolutionError of the resolution metadata.

Trait Implementations

impl Clone for ResolutionResult

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 ResolutionResult

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

Formats the value using the given formatter.

impl Default for ResolutionResult

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResolutionResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResolutionResult

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

The result as compact JSON, or a placeholder naming the reason when it cannot be serialized (a verification method holding a private JWK).

impl Eq for ResolutionResult

impl PartialEq for ResolutionResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResolutionResult

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 ResolutionResult