Enum BatchTaskError 

pub enum BatchTaskError<E> {
    Failed(E),
    Panicked {
        message: Option<String>,
    },
}

Error recorded for one task inside a batch execution.

Use this type to distinguish a task’s returned business error from a panic captured while running that task.

use qubit_batch::BatchTaskError;

let failed = BatchTaskError::Failed("invalid record");
assert!(failed.is_failed());
assert_eq!(failed.panic_message(), None);

let panicked: BatchTaskError<&'static str> = BatchTaskError::panicked("boom");
assert!(panicked.is_panicked());
assert_eq!(panicked.panic_message(), Some("boom"));

Type Parameters

• E - The task-specific error type.

Variants

Failed(E)

The task returned its own business error.

Panicked

The task panicked while running.

Fields

message: Option<String>

Captured panic message when the panic payload is a string.

Implementations

impl<E> BatchTaskError<E>

pub fn from_panic_payload(payload: &(dyn Any + Send)) -> Self

Creates a panicked task error from a captured panic payload.

Parameters

• payload - Panic payload captured by catch_unwind.

Returns

A panicked task error containing a string message when the payload carries one.

pub fn panicked(message: impl Into<String>) -> Self

Creates a panicked task error with a captured message.

Parameters

• message - Panic message captured from the task.

Returns

A panicked task error containing message.

pub const fn panicked_without_message() -> Self

Creates a panicked task error without a readable message.

Returns

A panicked task error with no captured message.

pub const fn is_failed(&self) -> bool

Returns whether this task error wraps the task’s own error value.

Returns

true if this error is Self::Failed.

pub const fn is_panicked(&self) -> bool

Returns whether this task error represents a panic.

Returns

true if this error is Self::Panicked.

pub fn panic_message(&self) -> Option<&str>

Returns the captured panic message, if one is available.

Returns

Some(message) when the panic payload was a string, or None for business errors and non-string panic payloads.

Trait Implementations

impl<E: Clone> Clone for BatchTaskError<E>

fn clone(&self) -> BatchTaskError<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for BatchTaskError<E>

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

Formats the value using the given formatter.

impl<E> Display for BatchTaskError<E>

where E: Display,

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

Formats this batch task error for users.

Parameters

• f - Formatter receiving the human-readable message.

Returns

The formatting result produced by write!.

impl<E> Error for BatchTaskError<E>

where E: Error + 'static,

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

Returns the wrapped task error as the source when this error represents a business failure.

Returns

Some(error) for Self::Failed, or None for task panics because a panic payload is not an error source.

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.

impl<E: PartialEq> PartialEq for BatchTaskError<E>

fn eq(&self, other: &BatchTaskError<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E: Eq> Eq for BatchTaskError<E>

impl<E> StructuralPartialEq for BatchTaskError<E>