Struct Error 

pub struct Error<K> { /* private fields */ }

Primary Error type from this crate. Error contains a kind and an optional payload, which may be an OS Error Code, a Custom Message, or (with an allocator available) a custom Error object.

Implementations

impl<K> Error<K>

pub const fn new_simple(kind: K) -> Self

Constructs a new error with a kind, but not payload

pub const fn new_with_message(kind: K, msg: &'static str) -> Self

Constructs a new error with a kind and a custom message

pub fn new<E: Into<Box<dyn Error + Send + Sync + 'static>>>( kind: K, error: E, ) -> Self

Constructs a new error with a kind and a custom payload

pub fn kind(&self) -> K

where K: Copy,

Returns the error Kind of the Error

pub fn raw_os_error(&self) -> Option<RawOsError>

Returns the raw os error if the error was constructed with one (via. Error::from_raw_os_error)

pub fn into_error(self) -> Option<Box<dyn Error + Send + Sync + 'static>>

Converts self into an boxed error if a custom payload is present. Error::into_error will return Some if constructed with a custom payload (Error::new, Error::other, or Error::uncategorized), or if constructed with a custom message (Error::new_with_message, Error::other_with_message, or Error::uncategorized_with_message), and None otherwise.

Note that the latter case cannot be downcast.

pub fn into_inner(self) -> Option<Box<dyn Error + Send + Sync + 'static>>

Converts self into an boxed error if a custom payload is present. Error::into_inner will return Some if constructed with a custom payload (Error::new, Error::other, or Error::uncategorized), and None otherwise.

impl<K: ErrorKind> Error<K>

pub const fn other_simple() -> Self

Constructs a new Error with no payload that indicates an other error.

pub const fn other_with_message(msg: &'static str) -> Self

Constructs a new Error with a custom message that indicates an other error.

pub fn other<E: Into<Box<dyn Error + Send + Sync + 'static>>>(error: E) -> Self

Constructs a new Error with a custom payload that indicates an other error.

pub fn uncategorized_simple() -> Self

Constructs a new Error with no payload that indicates an uncategorized error.

pub fn uncategorized_with_message(msg: &'static str) -> Self

Constructs a new Error with a custom message that indicates an uncategorized error.

pub fn uncategorized<E: Into<Box<dyn Error + Send + Sync + 'static>>>( error: E, ) -> Self

Constructs a new Error with a custom payload that indicates an uncategorized error.

impl<K: FromRawOsError> Error<K>

pub fn from_raw_os_error(error: RawOsError) -> Self

Constructs a new Error that contains an Error created from the OS

Trait Implementations

impl<K: Debug> Debug for Error<K>

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

Formats the value using the given formatter.

impl<K: ErrorKind> Display for Error<K>

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

Formats the value using the given formatter.

impl<K: ErrorKind> Error for Error<K>

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<K: IntoIoKind> From<Error<K>> for Error

Available on crate feature std only.

fn from(value: Error<K>) -> Self

Converts to this type from the input type.

impl<K: FromIoKind> From<Error> for Error<K>

Available on crate feature std only.

fn from(value: Error) -> Self

Converts to this type from the input type.

impl<K: FromIoKind> From<ErrorKind> for Error<K>

Available on crate feature std only.

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.