Struct BatchProcessResult 

pub struct BatchProcessResult { /* private fields */ }

Structured result produced by a batch processor.

The result distinguishes completed input items from successfully processed items because some processors can report a success count, such as affected database rows, that differs from the number of input items whose chunk returned.

use std::time::Duration;

use qubit_batch::BatchProcessResultBuilder;

let result = BatchProcessResultBuilder::builder(3)
    .completed_count(3)
    .processed_count(3)
    .chunk_count(1)
    .elapsed(Duration::ZERO)
    .build()
    .expect("process result counters should be consistent");

assert!(result.is_success());
assert_eq!(result.item_count(), 3);
assert_eq!(result.chunk_count(), 1);

Implementations

impl BatchProcessResult

pub const fn builder(item_count: usize) -> BatchProcessResultBuilder

Starts building a batch process result.

Parameters

• item_count - Declared item count for the batch.

Returns

A result builder initialized with zero counters and zero elapsed time.

pub const fn item_count(&self) -> usize

Returns the declared item count.

Returns

The expected number of input items.

pub const fn completed_count(&self) -> usize

Returns how many input items reached a terminal outcome.

Returns

The number of completed input items.

pub const fn processed_count(&self) -> usize

Returns how many items were reported as successfully processed.

Returns

The processor-reported success count.

pub const fn chunk_count(&self) -> usize

Returns the number of chunks submitted by the processor.

Returns

The submitted chunk count.

pub const fn elapsed(&self) -> Duration

Returns the total monotonic elapsed duration.

Returns

The elapsed duration for this batch processing attempt.

pub const fn is_success(&self) -> bool

Returns whether all declared items were processed successfully.

Returns

true when every declared item completed and was reported as processed.

Trait Implementations

impl Clone for BatchProcessResult

fn clone(&self) -> BatchProcessResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchProcessResult

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

Formats the value using the given formatter.

impl Display for BatchProcessResult

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

Formats a concise summary of this batch process result.

Parameters

• f - Formatter receiving the summary text.

Returns

The formatter result.

impl PartialEq for BatchProcessResult

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

impl StructuralPartialEq for BatchProcessResult