Skip to main content

ErrorChain

Struct ErrorChain 

Source
pub struct ErrorChain { /* private fields */ }
Available on crate feature alloc only.
Expand description

A diagnostic pairs a GraphError with an optional causal chain.

Both the outer error and every inner cause carry their own WDP code, forming a chain that provides context (what failed) at each level:

[E.ArenaLayout.Builder.026] IR builder allocation failed
  caused by: [E.ArenaLayout.Alloc.026] arena out of memory

§Construction

use ascii_dag::errors::{GraphError, ErrorChain};

// Leaf diagnostic (no cause)
let d = ErrorChain::from(GraphError::ArenaOom);
assert_eq!(d.code(), "E.ArenaLayout.Alloc.026");
assert!(d.cause().is_none());

// Chained diagnostic
let d = ErrorChain::from(GraphError::BuilderFailed)
    .caused_by(GraphError::ArenaOom);
assert_eq!(d.code(), "E.ArenaLayout.Builder.026");
assert_eq!(d.cause().unwrap().code(), "E.ArenaLayout.Alloc.026");

§Display

Display renders the full chain, indenting each cause level:

use ascii_dag::errors::{GraphError, ErrorChain};

let d = ErrorChain::from(GraphError::BuilderFailed)
    .caused_by(GraphError::ArenaOom);
let msg = d.to_string();
assert!(msg.contains("caused by:"));

Implementations§

Source§

impl ErrorChain

Source

pub fn new(error: GraphError) -> Self

Create a leaf diagnostic (no cause).

Source

pub fn caused_by(self, cause: GraphError) -> Self

Attach a cause to this diagnostic (builder pattern).

The cause is wrapped in its own ErrorChain with no further inner cause. For deeper chains, use caused_by_chain.

Source

pub fn caused_by_chain(self, cause: ErrorChain) -> Self

Attach an existing ErrorChain as the cause.

Source

pub fn error(&self) -> &GraphError

The GraphError at this level of the chain.

Source

pub fn code(&self) -> &'static str

WDP code of the outermost error.

Source

pub fn hint(&self) -> &'static str

Hint for the outermost error.

Source

pub fn cause(&self) -> Option<&ErrorChain>

The inner cause, if any.

Source

pub fn chain(&self) -> DiagnosticChain<'_> ⓘ

Iterate over the full chain: self, then cause, then cause’s cause, etc.

Trait Implementations§

Source§

impl Clone for ErrorChain

Source§

fn clone(&self) -> ErrorChain

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ErrorChain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ErrorChain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ErrorChain

Source§

impl Error for ErrorChain

Available on crate feature std only.
Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<GraphError> for ErrorChain

Source§

fn from(error: GraphError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ErrorChain

Source§

fn eq(&self, other: &ErrorChain) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl ProjectedFailure for ErrorChain

Source§

fn cause(&self) -> Option<&Self>

The next cause beneath this failure, if any.
Source§

impl StructuralPartialEq for ErrorChain

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.