Enum BatchProcessError 

pub enum BatchProcessError {
    CountShortfall {
        expected: usize,
        actual: usize,
        result: BatchProcessResult,
    },
    CountExceeded {
        expected: usize,
        observed_at_least: usize,
        result: BatchProcessResult,
    },
}

Error returned by built-in consumer-backed batch processors.

The error variants report mismatches between the declared item count and the number of items yielded by the input source. Each variant carries the partial result accumulated before the mismatch was detected.

use qubit_batch::{
    BatchProcessError,
    BatchProcessor,
    SequentialBatchProcessor,
};

let mut processor = SequentialBatchProcessor::new(|_item: &i32| {});
let error = processor
    .process_with_count([1], 2)
    .expect_err("iterator should yield fewer items than declared");

match error {
    BatchProcessError::CountShortfall { expected, actual, result } => {
        assert_eq!(expected, 2);
        assert_eq!(actual, 1);
        assert_eq!(result.completed_count(), 1);
    }
    BatchProcessError::CountExceeded { .. } => unreachable!(),
}

Variants

CountShortfall

The input source ended before the declared item count was reached.

Fields

expected: usize

Declared item count.

actual: usize

Actual number of items observed from the source.

result: BatchProcessResult

Result accumulated before the shortfall was reported.

CountExceeded

The input source yielded more items than the declared item count.

Fields

expected: usize

Declared item count.

observed_at_least: usize

Lower bound of observed items.

result: BatchProcessResult

Result accumulated before the excess item was observed.

Implementations

impl BatchProcessError

pub const fn result(&self) -> &BatchProcessResult

Returns the partial result attached to this error.

Returns

A shared reference to the partial batch process result.

pub fn into_result(self) -> BatchProcessResult

Consumes this error and returns its partial result.

Returns

The partial batch process result.

Trait Implementations

impl Clone for BatchProcessError

fn clone(&self) -> BatchProcessError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchProcessError

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

Formats the value using the given formatter.

impl Display for BatchProcessError

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

Formats the value using the given formatter.

impl Error for BatchProcessError

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 PartialEq for BatchProcessError

fn eq(&self, other: &BatchProcessError) -> 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 Eq for BatchProcessError

impl StructuralPartialEq for BatchProcessError