Struct ResolutionError 

pub struct ResolutionError { /* private fields */ }

Why a DID could not be resolved: a ResolutionErrorKind keyword, and optionally a human-readable detail and the underlying error.

The keyword is the error as DID Core defines it: it is what the error serializes as, what ResolutionMetadata::error reports, and the only part two errors are compared on. The detail (the HTTP status of a failed did:web fetch, the ids of a mismatched document) and the source (the HTTP client’s error, the JSON or decoding error) are diagnostics: they appear in Display and Error::source, and are lost when the error is serialized.

Examples

use std::error::Error as _;

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

let cause = std::io::Error::other("connection refused");
let error = ResolutionError::new(ResolutionErrorKind::InternalError)
    .with_detail("fetching `https://example.com/.well-known/did.json` failed")
    .with_source(cause);

assert_eq!(error.kind(), &ResolutionErrorKind::InternalError);
assert_eq!(error, ResolutionErrorKind::InternalError);
assert_eq!(error.as_str(), "internalError");
assert_eq!(
    error.to_string(),
    "internal resolver error: fetching `https://example.com/.well-known/did.json` failed: \
     connection refused"
);
assert!(error.source().unwrap().downcast_ref::<std::io::Error>().is_some());
assert_eq!(serde_json::to_string(&error)?, r#""internalError""#);

Implementations

impl ResolutionError

pub const fn new(kind: ResolutionErrorKind) -> Self

An error reporting kind, without detail or source.

pub fn with_detail(self, detail: impl Into<String>) -> Self

This error with a human-readable detail, replacing any previous one.

pub fn with_source<E: Error + Send + Sync + 'static>(self, source: E) -> Self

This error caused by source, replacing any previous source.

pub const fn kind(&self) -> &ResolutionErrorKind

The keyword.

pub fn as_str(&self) -> &str

The registered keyword, for example notFound.

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

The human-readable detail, if any.

Trait Implementations

impl Clone for ResolutionError

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 ResolutionError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResolutionError

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ResolutionError

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

The keyword’s description, then the detail and the source’s message when present, each after a colon.

impl Eq for ResolutionError

impl Error for ResolutionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DidError> for ResolutionError

fn from(error: DidError) -> Self

ResolutionErrorKind::InvalidDid, caused by error.

impl From<ResolutionError> for DomainLinkageError

Available on crate feature domain-linkage only.

fn from(source: ResolutionError) -> Self

Converts to this type from the input type.

impl From<ResolutionError> for LinkedVpError

Available on crate feature linked-vp only.

fn from(source: ResolutionError) -> Self

Converts to this type from the input type.

impl From<ResolutionErrorKind> for ResolutionError

fn from(kind: ResolutionErrorKind) -> Self

Converts to this type from the input type.

impl FromStr for ResolutionError

fn from_str(s: &str) -> Result<Self, Self::Err>

Never fails: an unknown keyword becomes ResolutionErrorKind::Other.

type Err = !

The associated error which can be returned from parsing.

impl Hash for ResolutionError

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 ResolutionError

Errors are equal when their keywords are; the detail and the source are not compared, so an error equals its own serialization round trip.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ResolutionErrorKind> for ResolutionError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResolutionError

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.