Enum Error 

#[non_exhaustive]
pub enum Error {
    MalformedEnvelope(String),
    NonCanonicalBase64 {
        field: &'static str,
    },
    NoSignatures,
    ThresholdNotMet {
        accepted: usize,
        threshold: usize,
    },
    ZeroThreshold,
    DuplicateKeyId {
        key_id: String,
    },
    DuplicateKeyIdentity {
        first: usize,
        second: usize,
    },
    UnidentifiedKey {
        index: usize,
    },
    UnidentifiedKeyIdentity {
        index: usize,
    },
    EmptyPayloadType,
    TooManySignatures {
        got: usize,
        cap: usize,
    },
    Signing(String),
    InvalidKey(String),
}

Errors from envelope, threshold and key validation, or a signing backend.

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.

MalformedEnvelope(String)

The envelope was not well-formed JSON, or a required member was absent.

NonCanonicalBase64

payload or a sig was not canonical RFC 4648 base64 in either the standard or the URL-safe alphabet.

Fields

field: &'static str

The envelope member that failed to decode.

NoSignatures

signatures was present but empty. The envelope schema requires at least one signature, so an empty list can never be satisfied.

ThresholdNotMet

Fewer than threshold distinct trusted keys produced a valid signature.

Fields

accepted: usize

How many distinct trusted keys verified.

threshold: usize

How many were required.

ZeroThreshold

A threshold of zero was requested. Zero would verify an envelope with no valid signature at all.

DuplicateKeyId

Two supplied keys reported the same identifier, so a threshold cannot count them apart. The count is over distinct keys, and a set that cannot be counted is refused rather than counted wrongly.

Fields

key_id: String

The identifier two keys share.

DuplicateKeyIdentity

Two verifier entries refer to the same verification key under different identifiers. Counting both would let one signature satisfy a threshold.

Fields

first: usize

First occurrence in the supplied key set.

second: usize

Repeated occurrence in the supplied key set.

UnidentifiedKey

A threshold above one was requested with a key that reports no identifier. Anonymous keys cannot be told apart, so the same key supplied twice would satisfy a 2-of-n on its own.

Fields

index: usize

Which supplied key, by position.

UnidentifiedKeyIdentity

A key set cannot prove distinct keys when one verifier reports only a caller-chosen label instead of a stable key identity.

Fields

index: usize

Which supplied key, by position.

EmptyPayloadType

payloadType was present but empty. An empty type binds nothing, and the whole purpose of the pre-authentication encoding is to bind the type.

TooManySignatures

The envelope carries more signature entries than crate::MAX_SIGNATURES.

Fields

got: usize

How many entries it carried.

cap: usize

The cap.

Signing(String)

The signer could not produce a signature.

InvalidKey(String)

A key could not be constructed from the supplied bytes.

Trait Implementations

impl Clone for Error

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 Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error