Struct BatchOutcome 

pub struct BatchOutcome<E> { /* private fields */ }

Final or partial outcome produced by one batch execution.

Create outcomes through BatchOutcomeBuilder::build so counters and failure details are validated before the outcome exists.

use qubit_batch::{
    BatchOutcome,
    BatchOutcomeBuilder,
};

let outcome: BatchOutcome<&'static str> = BatchOutcomeBuilder::builder(2)
    .completed_count(2)
    .succeeded_count(2)
    .build()
    .expect("outcome counters should be consistent");

assert!(outcome.is_success());
assert_eq!(outcome.failure_count(), 0);

use qubit_batch::{
    BatchOutcome,
    BatchOutcomeBuilder,
};

let builder = BatchOutcomeBuilder::<&'static str>::builder(1);
let _outcome = BatchOutcome::new(builder);

Implementations

impl<E> BatchOutcome<E>

pub const fn task_count(&self) -> usize

Returns the declared task count for this batch.

Returns

The expected number of tasks supplied by the caller.

pub const fn completed_count(&self) -> usize

Returns how many tasks reached a terminal outcome.

Returns

The number of completed tasks.

pub const fn succeeded_count(&self) -> usize

Returns how many tasks completed successfully.

Returns

The number of successful tasks.

pub const fn failed_count(&self) -> usize

Returns how many tasks returned their own error.

Returns

The number of failed tasks.

pub const fn panicked_count(&self) -> usize

Returns how many tasks panicked.

Returns

The number of panicked tasks.

pub const fn failure_count(&self) -> usize

Returns the total number of task failures.

Returns

Failed plus panicked task count.

pub fn progress_counters(&self) -> ProgressCounters

Builds generic progress counters from this outcome for terminal progress reporting.

Returns

Counters with total set to Self::task_count, completed to Self::completed_count, succeeded to Self::succeeded_count, and failed to Self::failure_count (errors plus panics). Active count stays zero because the batch has finished.

pub const fn elapsed(&self) -> Duration

Returns the total monotonic elapsed duration.

Returns

The elapsed duration for this batch execution.

pub fn failures(&self) -> &[BatchTaskFailure<E>]

Returns the detailed failure records collected during execution.

Returns

A shared slice of task failure records.

pub const fn is_success(&self) -> bool

Returns whether every task completed successfully.

Returns

true if the batch has no failures and every declared task completed.

pub fn into_failures(self) -> Vec<BatchTaskFailure<E>>

Consumes this outcome and returns its failure list.

Returns

The detailed failure records collected during execution.

Trait Implementations

impl<E: Clone> Clone for BatchOutcome<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for BatchOutcome<E>

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

Formats the value using the given formatter.

impl<E> Display for BatchOutcome<E>

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

Formats a concise summary of this batch outcome.

Parameters

• formatter - Formatter receiving the summary text.

Returns

The formatting result.

impl<E: PartialEq> PartialEq for BatchOutcome<E>

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

impl<E> StructuralPartialEq for BatchOutcome<E>