Struct eyre::DefaultHandler

pub struct DefaultHandler { /* private fields */ }

The default provided error report handler for eyre::Report.

On nightly this supports conditionally capturing a std::backtrace::Backtrace if the source error did not already capture one.

Implementations

impl DefaultHandler

pub fn default_with(error: &(dyn StdError + 'static)) -> Box<dyn EyreHandler>

Manual hook which constructs DefaultHandlers.

Details

When supplied to the set_hook function, default_with will cause eyre::Report to use DefaultHandler as the error report handler.

If the auto-install feature is enabled, and a user-provided hook for constructing EyreHandlers was not installed using set_hook, DefaultHandler::default_with is automatically installed as the hook.

Example

use eyre::{DefaultHandler, eyre, InstallError, Result, set_hook};

fn main() -> Result<()> {
    install_default().expect("default handler inexplicably already installed");
    Err(eyre!("hello from default error city!"))
}

fn install_default() -> Result<(), InstallError> {
    set_hook(Box::new(DefaultHandler::default_with))
}

Trait Implementations

impl Debug for DefaultHandler

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

Formats the value using the given formatter.

impl EyreHandler for DefaultHandler

fn debug(
    &self,
    error: &(dyn StdError + 'static),
    f: &mut Formatter<'_>
) -> Result

Define the report format

fn track_caller(&mut self, location: &'static Location<'static>)

Store the location of the caller who constructed this error report

fn display(
    &self,
    error: &(dyn StdError + 'static),
    f: &mut Formatter<'_>
) -> Result

Override for the Display format