Struct watchexec::ErrorHook

pub struct ErrorHook {
    pub error: RuntimeError,
    /* private fields */
}

The environment given to the error handler.

This deliberately does not implement Clone to make it hard to move it out of the handler, which you should not do.

The ErrorHook::critical() method should be used to send a CriticalError, which will terminate watchexec. This is useful to e.g. upgrade certain errors to be fatal.

Note that returning errors from the error handler does not result in critical errors.

Fields

error: RuntimeError

The runtime error for which this handler was called.

Implementations

impl ErrorHook

pub fn critical(self, critical: CriticalError)

Set a critical error to be emitted.

This takes self and ErrorHook is not Clone, so it’s only possible to call it once. Regardless, if you do manage to call it twice, it will do nothing beyond the first call.

pub fn elevate(self)

Elevate the current runtime error to critical.

This is a shorthand method for ErrorHook::critical(CriticalError::Elevated(error)).

Trait Implementations

impl Debug for ErrorHook

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

Formats the value using the given formatter.