Struct Error 

pub struct Error { /* private fields */ }

Failure to produce an operation’s requested output.

Every value contains a registered error diagnostic. An underlying I/O or library error remains available through std::error::Error::source.

Implementations

impl Error

pub fn new(info: &'static DiagnosticInfo, message: impl Into<String>) -> Self

Construct a failure from a registered code carrying a category.

A code that ends an operation must declare a category, because the category is what a binding and an exit status project the failure onto. A code that does not is a registry defect: the finding keeps its own code so its identity is not lost, and a REQUEST.DIAGNOSTIC.MISSING_CATEGORY note records the defect. A debug build asserts instead, so the defect surfaces in tests rather than in a released binding.

pub fn with_diagnostic(self, diagnostic: Diagnostic) -> Self

Add a diagnostic emitted before or while the operation failed.

pub fn with_diagnostics( self, diagnostics: impl IntoIterator<Item = Diagnostic>, ) -> Self

Add diagnostics without changing their order.

pub fn with_cause(self, cause: impl Error + Send + Sync + 'static) -> Self

Retain the implementation error that caused this operation failure.

pub fn with_source(self, source: Source) -> Self

Retain the shared input owner needed to interpret diagnostic spans.

pub fn diagnostics(&self) -> &[Diagnostic]

pub fn info(&self) -> Option<&'static DiagnosticInfo>

The registered entry of the diagnostic that ended the operation, when the failure was built from one.

pub fn category(&self) -> ErrorCategory

Coarse projection from the first registered error diagnostic.

pub const fn retained_source(&self) -> Option<&Source>

pub fn into_diagnostics(self) -> Vec<Diagnostic>

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, formatter: &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.