Enum Error

#[non_exhaustive]
pub enum Error<E = Infallible> {
    LockPoisoned(PhantomData<E>),
    Base32Error(Base32Error<E>),
}

All possible errors that ferroid can produce.

The generic parameter E is only used when the base32 feature is enabled, in the Base32Error<E> variant. To preserve the generic across all feature combinations, other variants carry a PhantomData<E>, even if unused.

When both std and base32 are disabled, ferroid is effectively infallible. The Infallible variant exists only to satisfy the type system and is never expected to surface in practice.

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.

LockPoisoned(PhantomData<E>)

The operation failed due to a poisoned lock.

This can happen if another thread panicked while holding a shared lock. Only available when the std feature is enabled.

Base32Error(Base32Error<E>)

An error occurred during Crockford Base32 decoding.

This wraps the crate::Base32Error type and is only available when the base32 feature is enabled.

Trait Implementations

impl<E: Clone> Clone for Error<E>

fn clone(&self) -> Error<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Error<E>

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

Formats the value using the given formatter.

impl<E: Debug> Display for Error<E>

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

Formats the value using the given formatter.

impl<E: Debug> Error for Error<E>

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<E: Debug> From<Base32Error<E>> for Error<E>

fn from(err: Base32Error<E>) -> Self

Converts to this type from the input type.

impl<T, E: Debug> From<PoisonError<MutexGuard<'_, T>>> for Error<E>

fn from(_: PoisonError<MutexGuard<'_, T>>) -> Self

Converts to this type from the input type.