Enum Error

pub enum Error {
    CborEncoding(Error<Error>),
    CborDecoding(Error<Error>),
    Io(Error),
    Base64Decoding(DecodeError),
    Json(Error),
    KeyNotFound(String),
    InvalidIssuer {
        expected: String,
        actual: String,
    },
    TokenExpired,
    TokenNotActive,
    InvalidAudience(Vec<String>),
    InvalidClaimType,
    TagMismatch,
    ExpectedCwtTag,
    FailedToMac,
    UnsupportedValidationType,
    UnableToParseToken,
    MissingOptionsForMacValidation,
}

Errors that can occur during CAT token operations.

This enum represents all the possible errors that can occur when generating, validating, or processing CAT tokens. Each variant provides specific information about what went wrong.

Examples

use common_access_token::{Cat, CatOptions, CatValidationOptions, CatValidationType};
use std::collections::HashMap;

// Create a CAT instance with a key
let key = hex::decode("403697de87af64611c1d32a05dab0fe1fcb715a86ab435f1ec99192d79569388").unwrap();
let cat = Cat::new(CatOptions {
    keys: HashMap::from([("key-1".to_string(), key)]),
    expect_cwt_tag: true,
});

// Try to validate an invalid token
let result = cat.validate(
    "invalid-token",
    CatValidationType::Mac,
    &CatValidationOptions {
        issuer: "issuer".to_string(),
        audience: None,
    },
);

// Handle the error
match result {
    Ok(_) => println!("Token is valid"),
    Err(err) => println!("Error: {}", err),
}

Variants

CborEncoding(Error<Error>)

CborDecoding(Error<Error>)

Io(Error)

Base64Decoding(DecodeError)

Json(Error)

KeyNotFound(String)

InvalidIssuer

Fields

expected: String

actual: String

TokenExpired

TokenNotActive

InvalidAudience(Vec<String>)

InvalidClaimType

TagMismatch

ExpectedCwtTag

FailedToMac

UnsupportedValidationType

UnableToParseToken

MissingOptionsForMacValidation

Trait Implementations

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.

impl From<DecodeError> for Error

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error<Error>> for Error

fn from(source: Error<Error>) -> Self

Converts to this type from the input type.

impl From<Error<Error>> for Error

fn from(source: Error<Error>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.