Enum BatchExecutionError 

pub enum BatchExecutionError<E> {
    CountShortfall {
        expected: usize,
        actual: usize,
        outcome: BatchOutcome<E>,
    },
    CountExceeded {
        expected: usize,
        observed_at_least: usize,
        outcome: BatchOutcome<E>,
    },
}

Batch-level error returned when the batch contract is violated.

Task failures are reported through BatchOutcome, not through this enum. This error is reserved for situations such as declared task-count mismatches.

use qubit_batch::{
    BatchExecutionError,
    BatchExecutor,
    SequentialBatchExecutor,
};

let error = SequentialBatchExecutor::new()
    .for_each_with_count([10, 20], 3, |_value| Ok::<(), &'static str>(()))
    .expect_err("iterator should yield fewer items than declared");

assert!(error.is_count_shortfall());
assert_eq!(error.outcome().completed_count(), 2);
match error {
    BatchExecutionError::CountShortfall { expected, actual, .. } => {
        assert_eq!(expected, 3);
        assert_eq!(actual, 2);
    }
    BatchExecutionError::CountExceeded { .. } => unreachable!(),
}

Type Parameters

• E - The task-specific error type stored inside the attached outcome.

Variants

CountShortfall

The task source ended before the declared task count was reached.

Fields

expected: usize

Declared task count.

actual: usize

Actual number of tasks observed from the source.

outcome: BatchOutcome<E>

Outcome accumulated from the tasks that did run.

CountExceeded

The task source yielded more tasks than the declared task count.

Fields

expected: usize

Declared task count.

observed_at_least: usize

Lower bound of observed tasks. This is typically expected + 1 because the executor stops reading once it confirms the overflow.

outcome: BatchOutcome<E>

Outcome accumulated from the tasks that did run.

Implementations

impl<E> BatchExecutionError<E>

pub const fn outcome(&self) -> &BatchOutcome<E>

Returns the batch outcome attached to this error.

Returns

A shared reference to the attached batch outcome.

pub fn into_outcome(self) -> BatchOutcome<E>

Consumes this error and returns the attached batch outcome.

Returns

The batch outcome accumulated before this error was reported.

pub const fn is_count_shortfall(&self) -> bool

Returns whether this error represents a task-count shortfall.

Returns

true if this error is Self::CountShortfall.

pub const fn is_count_exceeded(&self) -> bool

Returns whether this error represents an oversized task source.

Returns

true if this error is Self::CountExceeded.

Trait Implementations

impl<E: Clone> Clone for BatchExecutionError<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for BatchExecutionError<E>

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

Formats the value using the given formatter.

impl<E> Display for BatchExecutionError<E>

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

Formats the value using the given formatter.

impl<E> Error for BatchExecutionError<E>

where Self: Debug + Display,

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.

impl<E: PartialEq> PartialEq for BatchExecutionError<E>

fn eq(&self, other: &BatchExecutionError<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 BatchExecutionError<E>

impl<E> StructuralPartialEq for BatchExecutionError<E>