Struct Error 

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

An error container.

Error<E> is a lightweight handle to an error that can be cheaply cloned and safely shared across threads. It preserves the original error along with associated context such as where it occurred.

Implementations

impl<E> Error<E>

pub fn new<T>(error: T, service: &'static str) -> Self

where E: From<T>,

Creates a new error container.

Captures the caller location and associates the error with a service.

pub fn forward<U, F>(self, f: F) -> Error<U>

where F: FnOnce(Error<E>) -> U,

Transforms the inner error into another error type.

Preserves service, backtrace, and extension data.

pub fn debug(&self) -> impl Debug

where E: Debug,

Returns a debug view of the error.

Intended for debugging purposes.

pub fn get_item<T: 'static>(&self) -> Option<&T>

Returns a reference to a previously stored value of type T from this error.

This can be used to access additional contextual data attached to the error.

impl<E: Clone> Error<E>

pub fn set_tag<T: Into<Bytes>>(self, tag: T) -> Self

Sets a user-defined tag on this error.

Returns the updated error.

pub fn set_service(self, name: &'static str) -> Self

Sets the service responsible for this error.

Returns the updated error.

pub fn map<U, F>(self, f: F) -> Error<U>

where F: FnOnce(E) -> U,

Maps the inner error into a new error type.

Preserves service, backtrace, and extension data.

pub fn try_map<T, U, F>(self, f: F) -> Result<T, Error<U>>

where F: FnOnce(E) -> Result<T, U>,

Try to map inner error to new error.

Preserves service, backtrace, and extension data.

pub fn insert_item<T: Sync + Send + 'static>(self, val: T) -> Self

Attaches a typed value to this Error.

This value can be retrieved later using get_item::<T>().

impl<E: Clone> Error<E>

pub fn into_error(self) -> E

Consumes this error and returns the inner error value.

Trait Implementations

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

type Target = E

The resulting type after dereferencing.

fn deref(&self) -> &E

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<E: Error + 'static> 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: ErrorDiagnostic> ErrorDiagnostic for Error<E>

type Kind = <E as ErrorDiagnostic>::Kind

fn kind(&self) -> Self::Kind

Returns the classification kind of this error.

fn tag(&self) -> Option<&Bytes>

Returns an optional tag associated with this error.

fn service(&self) -> Option<&'static str>

Returns the name of the responsible service, if applicable.

fn backtrace(&self) -> Option<&Backtrace>

Returns a backtrace for debugging purposes, if available.

fn chain(self) -> ErrorChain<Self::Kind>

where Self: Sized,

impl<E> From<&Error<E>> for ErrorInfo

where E: ErrorDiagnostic,

fn from(err: &Error<E>) -> Self

Converts to this type from the input type.

impl<E> From<E> for Error<E>

fn from(error: E) -> Self

Converts to this type from the input type.

impl<E, K> From<Error<E>> for ErrorChain<K>

where E: ErrorDiagnostic<Kind = K> + Sized, K: ResultKind,

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

Converts to this type from the input type.

impl<E> From<Error<E>> for ErrorInfo

where E: ErrorDiagnostic,

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

Converts to this type from the input type.

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

where E: PartialEq,

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

where E: PartialEq,

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

where E: Eq,