Enum Error

pub enum Error {
    CborEncoding,
    CborDecoding,
    Base64Decoding,
    Io,
    KeyNotFound(String),
    InvalidIssuer {
        expected: String,
        actual: String,
    },
    TokenExpired,
    TokenNotActive,
    InvalidAudience,
    MacFailed,
    TagMismatch,
    ExpectedCwtTag,
    UnsupportedValidationType,
    MissingMacOptions,
    UnableToParseToken,
    InvalidClaimType,
    InvalidJson,
}

Error types for the Common Access Token (CAT) library.

This enum represents all possible errors that can occur during token generation, parsing, and validation.

Variants

CborEncoding

Error during CBOR encoding.

CborDecoding

Error during CBOR decoding.

Base64Decoding

Error when decoding Base64 data.

Io

I/O error.

KeyNotFound(String)

Specified key ID was not found in the key store.

InvalidIssuer

Token issuer does not match the expected value.

Fields

expected: String

actual: String

TokenExpired

Token has expired (current time is past the exp claim).

TokenNotActive

Token is not yet active (current time is before the nbf claim).

InvalidAudience

Token audience does not match any of the expected audiences.

MacFailed

Failed to create MAC for token.

TagMismatch

MAC tag verification failed.

ExpectedCwtTag

CWT tag was expected but not found in the token.

UnsupportedValidationType

The requested validation type is not supported.

MissingMacOptions

Required options for MAC validation are missing.

UnableToParseToken

Token could not be parsed correctly.

InvalidClaimType

A claim has an invalid data type.

InvalidJson

JSON format is invalid.

Implementations

impl Error

pub fn is_validation_error(&self) -> bool

Returns true if the error indicates a validation failure rather than a structural or parsing error. Validation failures include expired tokens, invalid issuers, etc.

pub fn is_structural_error(&self) -> bool

Returns true if the error indicates a structural or format error rather than a validation error. These include encoding/decoding errors, missing keys, etc.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy 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 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.