Struct error_trace::ErrorTraceFormatter

pub struct ErrorTraceFormatter<'s, 'e> { /* private fields */ }

Formats an error and all its dependencies.

If you have the colours-feature enabled, then you can also use [ErrorTraceColourFormatter] to do the same but with colours.

Example

use error_trace::{ErrorTrace as _, ErrorTraceFormatter};

#[derive(Debug)]
struct ExampleError {
    msg: String,
}
impl Display for ExampleError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FResult { write!(f, "{}", self.msg) }
}
impl Error for ExampleError {}

let err = ExampleError { msg: "Hello, world!".into() };
let fmt: ErrorTraceFormatter = err.trace();
assert_eq!(format!("{fmt}"), "Hello, world!");

Implementations

impl<'s, 'e> ErrorTraceFormatter<'s, 'e>

pub fn new( msg: impl Into<Cow<'s, str>>, err: Option<&'e (dyn Error + 'static)>, ) -> Self

Builds a formatter for a given “anonymous error”.

This is useful for creating one-time error traces where you don’t want to create the root type.

For even more convenience, see the trace!-macro.

Arguments

• msg: A message that is printed as “current error”.
• err: An optional error that, if any, will cause this formatter to start printing a trace based on the error’s Error::source()-implementation.

Returns

A new ErrorTraceFormatter ready to rock-n-roll.

Trait Implementations

impl<'s, 'e> Display for ErrorTraceFormatter<'s, 'e>

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

Formats the value using the given formatter.