Struct ErrorContext 

pub struct ErrorContext { /* private fields */ }

Builder-style context wrapper used by public crate error types.

Implementations

impl ErrorContext

pub fn new( code: ErrorCode, message: impl Into<String>, remediation: Remediation, ) -> Self

Creates a new error context with the required code, message, and remediation.

pub fn cause(self, cause: impl Into<String>) -> Self

Adds a human-readable cause string to the error context.

pub fn docs(self, docs: impl Into<String>) -> Self

Adds a documentation reference string to the error context.

pub fn detail(self, key: impl Into<String>, value: Value) -> Self

Adds one structured detail field to the error context.

pub fn source(self, source: Box<dyn Error + Send + Sync + 'static>) -> Self

Captures the real source error for display and error chaining.

pub fn diagnostic(&self) -> &Diagnostic

Returns the structured diagnostic carried by this error context.

pub fn backtrace(&self) -> &Backtrace

Returns the captured construction backtrace.

Trait Implementations

impl Debug for ErrorContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorContext

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

Formats the value using the given formatter.

impl Error for ErrorContext

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 PartialEq for ErrorContext

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 Serialize for ErrorContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.