Enum Error

pub enum Error {
    Parameter {
        name: Cow<'static, str>,
        reason: Cow<'static, str>,
    },
    Length {
        context: &'static str,
        expected: usize,
        actual: usize,
    },
    Authentication {
        algorithm: &'static str,
    },
    NotImplemented {
        feature: &'static str,
    },
    Processing {
        operation: &'static str,
        details: &'static str,
    },
    MacError {
        algorithm: &'static str,
        details: &'static str,
    },
    External {
        source: &'static str,
        details: String,
    },
    Other(&'static str),
}

The error type for cryptographic primitives

Variants

Parameter

Parameter validation error

Fields

name: Cow<'static, str>

Name of the invalid parameter

reason: Cow<'static, str>

Reason why the parameter is invalid

Length

Length validation error

Fields

context: &'static str

Context where the length error occurred

expected: usize

Expected length in bytes

actual: usize

Actual length in bytes

Authentication

Authentication failure (e.g., AEAD tag verification)

Fields

algorithm: &'static str

Algorithm that failed authentication

NotImplemented

Feature not implemented

Fields

feature: &'static str

Name of the unimplemented feature

Processing

Processing error during cryptographic operation

Fields

operation: &'static str

Operation that failed

details: &'static str

Additional details about the failure

MacError

MAC error

Fields

algorithm: &'static str

MAC algorithm that encountered the error

details: &'static str

Additional details about the MAC error

External

External errors with String details (only available with alloc/std)

Fields

source: &'static str

Source of the external error

details: String

Detailed error message

Other(&'static str)

Fallback for other errors

Implementations

impl Error

pub fn param<N: Into<Cow<'static, str>>, R: Into<Cow<'static, str>>>( name: N, reason: R, ) -> Self

Shorthand to create a Parameter error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

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, f: &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<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 Error

impl StructuralPartialEq for Error