Enum ErrorKind

#[non_exhaustive]
pub enum ErrorKind {
    InvalidToken,
    InvalidSignature,
    InvalidEcdsaKey,
    InvalidRsaKey(&'static str),
    RsaFailedSigning,
    InvalidAlgorithmName,
    InvalidKeyFormat,
    MissingRequiredClaim(String),
    ExpiredSignature,
    InvalidIssuer,
    InvalidAudience,
    InvalidSubject,
    ImmatureSignature,
    InvalidAlgorithm,
    MissingAlgorithm,
    Base64(DecodeError),
    Json(Arc<Error>),
    Utf8(FromUtf8Error),
    Crypto(Unspecified),
}

The specific type of an error.

This enum may grow additional variants, the #[non_exhaustive] attribute makes sure clients don’t count on exhaustive matching. (Otherwise, adding a new variant could break existing code.)

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.

InvalidToken

When a token doesn’t have a valid JWT shape

InvalidSignature

When the signature doesn’t match

InvalidEcdsaKey

When the secret given is not a valid ECDSA key

InvalidRsaKey(&'static str)

When the secret given is not a valid RSA key

RsaFailedSigning

We could not sign with the given key

InvalidAlgorithmName

When the algorithm from string doesn’t match the one passed to from_str

InvalidKeyFormat

When a key is provided with an invalid format

MissingRequiredClaim(String)

When a claim required by the validation is not present

ExpiredSignature

When a token’s exp claim indicates that it has expired

InvalidIssuer

When a token’s iss claim does not match the expected issuer

InvalidAudience

When a token’s aud claim does not match one of the expected audience values

InvalidSubject

When a token’s sub claim does not match one of the expected subject values

ImmatureSignature

When a token’s nbf claim represents a time in the future

InvalidAlgorithm

When the algorithm in the header doesn’t match the one passed to decode or the encoding/decoding key used doesn’t match the alg requested

MissingAlgorithm

When the Validation struct does not contain at least 1 algorithm

Base64(DecodeError)

An error happened when decoding some base64 text

Json(Arc<Error>)

An error happened while serializing/deserializing JSON

Utf8(FromUtf8Error)

Some of the text was invalid UTF-8

Crypto(Unspecified)

Something unspecified went wrong with crypto

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Error

Converts to this type from the input type.

impl PartialEq for ErrorKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ErrorKind