Enum JwkError 

#[non_exhaustive]
pub enum JwkError {
    MissingMember(&'static str),
    InvalidBase64Url(&'static str),
    UnexpectedKeyType {
        expected: &'static str,
        kty: String,
        crv: Option<String>,
    },
    UnsupportedKeyType {
        kty: String,
        crv: Option<String>,
    },
    InvalidKey {
        key: &'static str,
        reason: String,
    },
    InvalidKeyLength {
        key: &'static str,
        expected: usize,
        actual: usize,
    },
    InvalidMultikey(String),
    UnsupportedMulticodec(u64),
    KeyMismatch {
        expected: KeyType,
    },
    FeatureDisabled {
        key: &'static str,
        feature: &'static str,
    },
    DecodingKey(Error),
}

Why a Jwk cannot be built, or cannot be used the way it was asked to.

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.

MissingMember(&'static str)

A member the key type requires is absent.

InvalidBase64Url(&'static str)

A member is not valid base64url without padding.

UnexpectedKeyType

The key has a different type than the operation needs, for example an RSA key where an Ed25519 key was expected.

Fields

expected: &'static str

The key type the operation needs, such as Ed25519 or RSA.

kty: String

The kty of the key.

crv: Option<String>

The crv of the key, if any.

UnsupportedKeyType

The key type or curve is not one this crate supports.

Fields

kty: String

The kty of the key.

crv: Option<String>

The crv of the key, if any.

InvalidKey

The key material does not decode to a valid key: wrong length, not on the curve, even modulus, and so on.

Fields

key: &'static str

The key type, such as P-256.

reason: String

What is wrong with it.

InvalidKeyLength

The key material has the wrong length for its type: a 31-byte Ed25519 key, say.

Fields

key: &'static str

The key type, such as Ed25519.

expected: usize

The length the key type requires.

actual: usize

The length found.

InvalidMultikey(String)

A Multikey (publicKeyMultibase) value is not base58btc multibase with a complete multicodec header.

UnsupportedMulticodec(u64)

A Multikey value carries a public key type this crate cannot read.

KeyMismatch

The encoded key is valid but not of the KeyType that was expected.

Fields

expected: KeyType

The key type the caller expected.

FeatureDisabled

Support for this key type is compiled out; enable the named Cargo feature.

Fields

key: &'static str

The key type, such as secp256k1.

feature: &'static str

The Cargo feature that enables it.

DecodingKey(Error)

jsonwebtoken rejected the key material; the source is its error.

Trait Implementations

impl Clone for JwkError

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 JwkError

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

Formats the value using the given formatter.

impl Display for JwkError

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

Formats the value using the given formatter.

impl Eq for JwkError

impl Error for JwkError

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<JwkError> for IdentityError

fn from(source: JwkError) -> Self

Converts to this type from the input type.

impl From<JwkError> for VerificationError

fn from(source: JwkError) -> Self

Converts to this type from the input type.

impl From<JwkError> for DidKeyError

Available on crate feature did-key and (crate features did-jwk or did-key or did-web) only.

fn from(source: JwkError) -> Self

Converts to this type from the input type.

impl PartialEq for JwkError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JwkError