Enum HexeractError 

#[non_exhaustive]
pub enum HexeractError {
    HandlerNotFound {
        command_type: &'static str,
    },
    HandlerFailed {
        source: Box<dyn Error + Send + Sync>,
    },
    #[non_exhaustive]
    Timeout {
        type_name: &'static str,
        duration: Duration,
    },
    #[non_exhaustive]
    DowncastFailed {
        expected: &'static str,
    },
    Dispatch(String),
}

Top-level error type for the Hexeract framework.

This enum is marked #[non_exhaustive] so that new variants can be added in minor versions without breaking downstream match arms.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

HandlerNotFound

No handler was registered for the given command or query type.

Fields

command_type: &'static str

The fully-qualified type name of the unregistered command or query.

HandlerFailed

A handler returned an error. The original error is preserved as source.

Fields

source: Box<dyn Error + Send + Sync>

The original error returned by the handler.

#[non_exhaustive]

Timeout

A dispatch exceeded its configured deadline.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

type_name: &'static str

Fully-qualified type name of the message being dispatched.

duration: Duration

Configured timeout that was exceeded.

#[non_exhaustive]

DowncastFailed

A dispatch produced a value that could not be downcast to the expected output type.

This indicates a short-circuiting Middleware boxed a value whose type is not the message’s Output. A correct short-circuit must box exactly the dispatched message’s output type.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

expected: &'static str

Fully-qualified name of the output type the dispatch expected.

Dispatch(String)

A generic dispatch-level error with a human-readable message.

Implementations

impl HexeractError

pub fn handler_failed(source: impl Error + Send + Sync + 'static) -> Self

Wraps any Send + Sync error as a HexeractError::HandlerFailed.

pub fn timeout(type_name: &'static str, duration: Duration) -> Self

Builds a HexeractError::Timeout from the dispatched message type name and the timeout that was exceeded. This is the only way to construct the variant from outside this crate, since it is marked #[non_exhaustive].

pub fn downcast_failed(expected: &'static str) -> Self

Builds a HexeractError::DowncastFailed from the fully-qualified name of the output type the dispatch expected. This is the only way to construct the variant from outside this crate, since it is marked #[non_exhaustive].

Trait Implementations

impl Debug for HexeractError

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

Formats the value using the given formatter.

impl Display for HexeractError

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

Formats the value using the given formatter.

impl Error for HexeractError

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.