Enum Error 

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

All error variants that ferroid can emit.

The generic parameter E is only material when the base32 feature is enabled, where it appears in Error::Base32Error. In all other cases, the enum carries a PhantomData<E> to keep the public type stable across feature combinations.

When base32 is disabled and either lock is disabled or parking-lot is enabled (no poisoning), the crate is effectively infallible at runtime. In that configuration, the Error::Infallible variant exists solely to satisfy the Result<T, Error<E>> API and should never be observed 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>)

Available on crate feature lock and non-crate feature parking-lot only.

The operation failed because the lock was poisoned.

This occurs when a thread panics while holding the lock. When the parking-lot feature is enabled, mutexes do not poison, so this variant is not available.

Base32Error(Base32Error<E>)

Available on crate feature base32 only.

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>

Available on crate feature base32 only.

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>

Available on crate feature lock and non-crate feature parking-lot only.

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

Converts to this type from the input type.

impl<E: Hash> Hash for Error<E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: Ord> Ord for Error<E>

fn cmp(&self, other: &Error<E>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<E: PartialEq> PartialEq for Error<E>

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

fn partial_cmp(&self, other: &Error<E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<E: Eq> Eq for Error<E>

impl<E> StructuralPartialEq for Error<E>