Enum DataIntegrityError 

#[non_exhaustive]
pub enum DataIntegrityError {
    UnsupportedCryptoSuite {
        name: String,
    },
    KeyTypeMismatch {
        expected: KeyType,
        actual: KeyType,
        suite: CryptoSuite,
    },
    InvalidSignature {
        suite: CryptoSuite,
        reason: SignatureFailure,
    },
    InvalidPublicKey {
        codec: Option<u64>,
        len: usize,
        reason: String,
    },
    Canonicalization(String),
    MalformedProof(String),
    Conformance(String),
    Signing(Box<dyn Error + Send + Sync>),
    Resolver(String),
}

Errors raised by data-integrity signing and verification.

This type is #[non_exhaustive]: callers must include a wildcard arm when matching, so future additions do not constitute breaking changes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnsupportedCryptoSuite

The cryptosuite identifier is not recognised by this build, either because the name is unknown or because the matching Cargo feature is disabled.

Fields

name: String

KeyTypeMismatch

The signer’s key type is not compatible with the requested cryptosuite.

Fields

expected: KeyType

actual: KeyType

suite: CryptoSuite

InvalidSignature

The signature could not be verified.

Fields

suite: CryptoSuite

reason: SignatureFailure

InvalidPublicKey

A public key has an unexpected multicodec, length, or encoding.

Fields

codec: Option<u64>

len: usize

reason: String

Canonicalization(String)

Canonicalization (JCS / RDFC / other) of the document or proof config failed.

MalformedProof(String)

The proof document is structurally invalid (missing required fields, wrong type, malformed created timestamp, mismatched @context, etc.).

Conformance(String)

A conformance check against the Data Integrity spec failed for a reason other than the signature itself (e.g. missing proofPurpose, wrong type, created in the future).

Signing(Box<dyn Error + Send + Sync>)

A signer (local or remote) returned an error while producing a signature.

Resolver(String)

A verification-method resolver (did:key, did:web, etc.) failed to locate or decode the requested key.

Implementations

impl DataIntegrityError

pub fn signing<E>(e: E) -> Self

where E: Error + Send + Sync + 'static,

Wraps any signer error (local keys, HSM, KMS) in the Signing variant. Preserves the source chain for debuggers.

Trait Implementations

impl Debug for DataIntegrityError

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

Formats the value using the given formatter.

impl Display for DataIntegrityError

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

Formats the value using the given formatter.

impl Error for DataIntegrityError

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.