Struct DefaultHandler

pub struct DefaultHandler { /* private fields */ }

Expand description

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

impl EyreHandler for DefaultHandler

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

Define the report format Read more

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

Auto Trait Implementations§

impl Freeze for DefaultHandler

impl RefUnwindSafe for DefaultHandler

impl Send for DefaultHandler

impl Sync for DefaultHandler

impl Unpin for DefaultHandler

impl UnwindSafe for DefaultHandler

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.