Struct DispatchError 

pub struct DispatchError<E> {
    pub undelivered: Vec<E>,
    pub source: PortError,
}

A dispatch failure that reports which events were not delivered, so a caller can retry or persist just the remainder instead of losing track of the whole batch.

Implementors that dispatch events one at a time should populate undelivered with every event from the input that was not confirmed delivered (typically the failing event and everything after it). Implementors that dispatch atomically (all-or-nothing) should populate it with the entire input batch on failure.

Examples

See EventDispatcher for a worked example of handling a DispatchError.

Fields

undelivered: Vec<E>

Events from the input batch that were not confirmed delivered.

source: PortError

The underlying failure.

Implementations

impl<E> DispatchError<E>

pub fn new(undelivered: Vec<E>, source: PortError) -> DispatchError<E>

Creates a new DispatchError.

Trait Implementations

impl<E> Debug for DispatchError<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<E> Display for DispatchError<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<E> Error for DispatchError<E>

where E: Debug,

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.