Struct Error

pub struct Error { /* private fields */ }

A minimalist error type to use in CLI scripts: it wraps an arbitrary cause which implements std::error::Error and a description for the Display implementation.

Implementations

impl Error

pub fn new<S, E>(description: S, cause: E) -> Error

where S: Into<Cow<'static, str>>, E: StdError + 'static,

Creates a new Error with a description and a cause.

In most cases you’ll want to use the convenient DescribeErr trait or the ctry and ccheck macros.

With a &'static str:

Error::new("oh no!", some_error);

With a String:

Error::new(format!("should not have tried to open '{}'!", filename), some_error);

pub fn with_description<S: Into<Cow<'static, str>>>(description: S) -> Error

Creates a new error with a descrption but no cause. Useful for validation specific errors where there’s no underlying error (e.g. CLI timeout argument must be greater than zero).

pub fn caused_by<E: StdError + 'static>(cause: E) -> Error

Creates a new error with a cause, but no description. The Display implementation forwards to that of cause in this case.

In most cases you’ll want to use the convenient DescribeErr trait or the ctry and ccheck macros instead.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn StdError>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

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.