Enum ChunkedBatchProcessError 

pub enum ChunkedBatchProcessError<E> {
    CountShortfall {
        expected: usize,
        actual: usize,
        result: BatchProcessResult,
    },
    CountExceeded {
        expected: usize,
        observed_at_least: usize,
        result: BatchProcessResult,
    },
    ChunkFailed {
        chunk_index: usize,
        start_index: usize,
        chunk_len: usize,
        source: E,
        result: BatchProcessResult,
    },
    InvalidChunkResult {
        chunk_index: usize,
        start_index: usize,
        chunk_len: usize,
        item_count: usize,
        completed_count: usize,
        result: BatchProcessResult,
    },
}

Error returned by crate::ChunkedBatchProcessor.

Count-mismatch variants carry the aggregate result accumulated before the mismatch was detected. ChunkFailed carries the delegate error plus the aggregate result collected before the failing chunk. InvalidChunkResult means the delegate returned Ok, but the returned item_count or completed_count did not match the submitted chunk length.

use std::time::Duration;

use qubit_batch::{
    BatchProcessResult,
    ChunkedBatchProcessError,
};

let result = BatchProcessResult::builder(4)
    .completed_count(2)
    .processed_count(2)
    .chunk_count(1)
    .elapsed(Duration::ZERO)
    .build()
    .expect("process result counters should be valid");
let error: ChunkedBatchProcessError<&'static str> =
    ChunkedBatchProcessError::ChunkFailed {
        chunk_index: 1,
        start_index: 2,
        chunk_len: 2,
        source: "insert failed",
        result,
    };

assert_eq!(error.result().processed_count(), 2);

Type Parameters

• E - Error type returned by the delegate processor.

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.

ChunkFailed

The delegate processor failed while processing one chunk.

Fields

chunk_index: usize

Zero-based chunk index.

start_index: usize

Zero-based source item index where this chunk starts.

chunk_len: usize

Number of items submitted in this chunk.

source: E

Error returned by the delegate processor.

result: BatchProcessResult

Result accumulated before this chunk failed.

InvalidChunkResult

The delegate returned Ok with counters that do not describe the submitted chunk.

A successful chunk delegate call must report both item_count and completed_count equal to chunk_len. A lower processed_count is allowed, but partial chunk completion should be represented by delegate failure instead of an inconsistent success result.

Fields

chunk_index: usize

Zero-based chunk index.

start_index: usize

Zero-based source item index where this chunk starts.

chunk_len: usize

Number of items submitted in this chunk.

item_count: usize

Delegate-reported declared item count.

completed_count: usize

Delegate-reported completed item count.

result: BatchProcessResult

Result accumulated before this invalid chunk result was reported.

Implementations

impl<E> ChunkedBatchProcessError<E>

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<E: Clone> Clone for ChunkedBatchProcessError<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for ChunkedBatchProcessError<E>

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

Formats the value using the given formatter.

impl<E> Display for ChunkedBatchProcessError<E>

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

Formats the value using the given formatter.

impl<E> Error for ChunkedBatchProcessError<E>

where E: Error + 'static, 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 ChunkedBatchProcessError<E>

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

impl<E> StructuralPartialEq for ChunkedBatchProcessError<E>