Enum Error 

#[non_exhaustive]
pub enum Error<E = ErrorKind> {
    Source(E),
    Context {
        kind: ErrorKind,
        message: Option<&'static str>,
    },
}

An error produced either by an underlying I/O object or by a Hadris helper.

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.

Source(E)

Error returned by the underlying reader, writer, or seeker.

Context

Error synthesized by Hadris, with optional allocation-free context.

Fields

kind: ErrorKind

Portable classification of the error.

message: Option<&'static str>

Static diagnostic context.

Implementations

impl<E> Error<E>

pub const fn from_source(source: E) -> Self

Wrap an error returned by the underlying I/O object.

pub const fn from_kind(kind: ErrorKind) -> Self

Construct a Hadris-generated error without additional context.

pub const fn new(kind: ErrorKind, message: &'static str) -> Self

Construct a Hadris-generated error with static context.

pub const fn other(message: &'static str) -> Self

Construct an Other error with static context.

pub const fn source_ref(&self) -> Option<&E>

Borrow the underlying source, if present.

pub fn into_source(self) -> Option<E>

Consume the error and return its underlying source, if present.

impl<E: Error> Error<E>

pub fn kind(&self) -> ErrorKind

Return the portable error kind.

pub fn erase(self) -> Error<ErrorKind>

Erase the concrete source while retaining its normalized kind.

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: Display> Display for Error<E>

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

Formats the value using the given formatter.

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

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

fn kind(&self) -> ErrorKind

Get the kind of this error.

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

Available on crate feature std only.

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

Converts to this type from the input type.

impl From<Error> for Error<Error>

Available on crate feature std only.

fn from(error: Error) -> Self

Converts to this type from the input type.

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

fn eq(&self, other: &Error<E>) -> bool

Equality operator ==.

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

Inequality operator !=.

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