Struct coded::Error

pub struct Error(_);

A general-purpose error with a “kind” from Google’s canonical error space.

This currently tracks:

• The error “kind”, taken from Google’s canonical error space.
• A human-readable message.
• An optional source/cause, exposed through std::error::Error::cause.
• An optional backtrace. This is present if coded was compiled with the backtrace or unstable_std_backtrace feature flags and the program was run with RUST_BACKTRACE or RUST_LIB_BACKTRACE set as described at std::backtrace.

The Display impl will display a short summary of this error itself. It won’t display the chain of sources or the backtrace.

To display this error along with its causes and stack trace, use the chain method.

Implementations

impl Error

pub fn new(kind: ErrorKind, msg: String) -> Self

Returns a new error with the given kind and message.

pub fn wrap<E: StdError + 'static>(
    kind: ErrorKind,
    msg: Option<String>,
    source: E
) -> Self

Returns a new error wrapping a source with no additional message.

pub fn kind(&self) -> ErrorKind

Returns the error kind.

pub fn chain(&self) -> impl Display + '_

Returns a borrowed value which can display not only this error but also the full chain of causes and (where applicable) the stack trace.

The exact format may change. Currently, it displays the stack trace for the current error but not any of the sources.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

Formats this error alone (not its full chain).

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)>

The lower-level source of this error, if any.

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

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<ErrorBuilder> for Error

fn from(builder: ErrorBuilder) -> Self

Performs the conversion.

impl ToErrKind for Error

fn err_kind(&self) -> ErrorKind