Enum HandlerError 

pub enum HandlerError {
    Benign(ComponentFault),
    Recoverable(ComponentFault),
    Unrecoverable(ComponentFault),
}

An abnormal result returned from a component handler.

Kompact does not classify application errors automatically. Users should convert their own error types into the variant that matches the intended runtime behaviour.

Variants

Benign(ComponentFault)

The handler observed an abnormal condition, but the component remains healthy.

Benign errors are logged and normal processing continues.

Recoverable(ComponentFault)

The component instance is faulty, but supervision may attempt recovery.

Recoverable errors mark the component as faulty and pass a FaultContext to the component’s recovery function. Top-level components without supervision poison the system.

Unrecoverable(ComponentFault)

The component instance is faulty and terminal.

Unrecoverable errors destroy the component without running recovery. Top-level components poison the system.

Implementations

impl HandlerError

pub fn benign<E>(error: E) -> HandlerError

where E: Error + Send + 'static,

Construct a benign handler error.

pub fn recoverable<E>(error: E) -> HandlerError

where E: Error + Send + 'static,

Construct a recoverable handler error.

pub fn unrecoverable<E>(error: E) -> HandlerError

where E: Error + Send + 'static,

Construct an unrecoverable handler error.

pub fn benign_boxed(error: Box<dyn Error + Send>) -> HandlerError

Construct a benign handler error from an already boxed error.

pub fn recoverable_boxed(error: Box<dyn Error + Send>) -> HandlerError

Construct a recoverable handler error from an already boxed error.

pub fn unrecoverable_boxed(error: Box<dyn Error + Send>) -> HandlerError

Construct an unrecoverable handler error from an already boxed error.

Trait Implementations

impl Debug for HandlerError

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

Formats the value using the given formatter.

impl Display for HandlerError

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

Formats the value using the given formatter.

impl Error for HandlerError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.