Struct Error 

pub struct Error { /* private fields */ }

A common error type for all Tango operations, which supports metadata and easy chaining of errors.

Implementations

impl Error

pub fn new(kind: ErrorKind<'_>) -> Self

Create a new error of the given kind, this will grab the origin of the error from the caller’s location. A default description is written depending on it by default, you can append or replace this description later.

pub fn reason(&self) -> &str

Return the standardized textual reason.

pub fn kind(&self) -> ErrorKind<'_>

Get the kind of error, returning the raw reason if not categorized.

pub fn set_kind(&mut self, kind: ErrorKind<'_>)

Change the kind of this error, this also ensures that the associated reason corresponds to the new error kind. If the description is empty at this point, the description is overridden with a default description.

pub fn with_kind(self, kind: ErrorKind<'_>) -> Self

Change the kind of this error, and return itself.

pub fn description(&self) -> &str

Return the description of the error.

pub fn append_description(&mut self, additional: impl Display)

Append the given additional description to the error’s description, if the description is currently empty, then this replaces the previous description. If a description already exists, it appends the description on a new line.

pub fn set_description(&mut self, description: impl Into<Cow<'static, str>>)

Overwrite any existing description with the given one.

pub fn with_append_description(self, additional: impl Display) -> Self

Same as Self::append_description, and return itself.

pub fn with_description(self, description: impl Into<Cow<'static, str>>) -> Self

Overwrite any existing description with the given one, and return itself.

pub fn severity(&self) -> ErrorSeverity

Return the severity of this error.

pub fn set_severity(&mut self, severity: ErrorSeverity)

Set the severity of the error.

pub fn with_severity(self, severity: ErrorSeverity) -> Self

Set the severity of the error, and return itself.

pub fn origin(&self) -> &str

Return the origin of this error, set by default to the caller’s code location.

pub fn append_origin(&mut self, additional: impl Display)

Append the given additional origin to the existing origin, in order to add details, a space is added before insertion. If the origin has been replaced and is empty, then no space is added.

pub fn set_origin(&mut self, origin: impl Into<Cow<'static, str>>)

Overwrite any existing origin with the given one.

pub fn with_append_origin(self, additional: impl Display) -> Self

Same as Self::append_origin, and return itself.

pub fn with_origin(self, origin: impl Into<Cow<'static, str>>) -> Self

Overwrite any existing origin with the given one, and return itself.

pub fn set_origin_from_caller(&mut self)

Overwrite the existing origin with the current location of the caller.

pub fn with_origin_from_caller(self) -> Self

Overwrite the existing origin with the current location of the caller, and return itself.

pub fn parent(&self) -> Option<&Error>

If the source of this error is a parent Tango error, returns a shared ref to it. To get a more generic source for this error, use the standard error::Error::source method.

pub fn set_parent(&mut self, parent: Error)

Set the parent source of this error.

pub fn with_parent(self, parent: Error) -> Self

Set the parent source of this error and return itself.

pub fn set_source(&mut self, source: impl Into<Box<dyn Error + Send + Sync>>)

Set the generic source of this error.

pub fn with_source( self, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Set the generic source of this error and return itself.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

Written like Display, within Error(...): the derived struct dump is what a main returning a Result would otherwise print, and it is unreadable. The alternate form gives the alternate one of Display, one error per block, with their origins.

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

Formats the value using the given formatter.

impl Display for Error

The whole chain of this error and its parents, on a single line, each error giving its reason and its description, escaped so that a description of several lines stays on that line: this is what a log line carries, see {:#} for what a person reads.

The alternate form gives an error per block, the origin of each of them along with it: a code location is noise in a log line, and the first thing wanted when debugging.

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

Formats the value using the given formatter.

impl Error for Error

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<!> for Error

fn from(never: Infallible) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.