Struct ProgressEventBuilder 

pub struct ProgressEventBuilder { /* private fields */ }

Builder for ProgressEvent.

The builder keeps the common path compact by letting callers configure phase, counters, optional stage information, and elapsed time in a single chain.

Examples

use std::time::Duration;

use qubit_progress::{
    ProgressEvent,
    ProgressPhase,
};

let event = ProgressEvent::builder()
    .running()
    .total(8)
    .completed(3)
    .active(1)
    .stage_named("copy", "Copy files")
    .elapsed(Duration::from_secs(2))
    .build();

assert_eq!(event.phase(), ProgressPhase::Running);
assert_eq!(event.counters().completed_count(), 3);
assert_eq!(event.stage().map(|stage| stage.id()), Some("copy"));

Implementations

impl ProgressEventBuilder

pub const fn new() -> Self

Creates a builder with default running progress state.

Returns

A builder whose phase is ProgressPhase::Running, elapsed duration is zero, total count is unknown, and all counters are zero.

pub const fn phase(self, phase: ProgressPhase) -> Self

Configures the lifecycle phase.

Parameters

• phase - Lifecycle phase to report.

Returns

This builder with phase recorded.

pub const fn started(self) -> Self

Configures the event as started.

Returns

This builder with ProgressPhase::Started.

pub const fn running(self) -> Self

Configures the event as running.

Returns

This builder with ProgressPhase::Running.

pub const fn finished(self) -> Self

Configures the event as finished.

Returns

This builder with ProgressPhase::Finished.

pub const fn failed(self) -> Self

Configures the event as failed.

Returns

This builder with ProgressPhase::Failed.

pub const fn canceled(self) -> Self

Configures the event as canceled.

Returns

This builder with ProgressPhase::Canceled.

pub const fn counters(self, counters: ProgressCounters) -> Self

Replaces the current counter set.

Parameters

• counters - Complete counter set to carry in the built event.

Returns

This builder with counters recorded.

pub const fn total(self, total_count: usize) -> Self

Configures a known total work-unit count.

Parameters

• total_count - Total number of work units.

Returns

This builder with a known total count.

pub const fn unknown_total(self) -> Self

Configures the event as unknown-total progress.

Returns

This builder with no total count.

pub const fn completed(self, completed_count: usize) -> Self

Configures the completed work-unit count.

Parameters

• completed_count - Number of completed work units.

Returns

This builder with completed_count recorded.

pub const fn active(self, active_count: usize) -> Self

Configures the active work-unit count.

Parameters

• active_count - Number of currently active work units.

Returns

This builder with active_count recorded.

pub const fn succeeded(self, succeeded_count: usize) -> Self

Configures the successful work-unit count.

Parameters

• succeeded_count - Number of successful work units.

Returns

This builder with succeeded_count recorded.

pub const fn failed_count(self, failed_count: usize) -> Self

Configures the failed work-unit count.

Parameters

• failed_count - Number of failed work units.

Returns

This builder with failed_count recorded.

pub fn stage(self, stage: ProgressStage) -> Self

Configures the current stage.

Parameters

• stage - Stage metadata to carry in the built event.

Returns

This builder with stage recorded.

pub fn stage_named(self, id: &str, name: &str) -> Self

Configures the current stage from an id and display name.

Parameters

• id - Stable machine-readable stage identifier.
• name - Human-readable stage name.

Returns

This builder with a stage created from id and name.

pub const fn elapsed(self, elapsed: Duration) -> Self

Configures the elapsed duration.

Parameters

• elapsed - Monotonic elapsed duration to carry in the event.

Returns

This builder with elapsed recorded.

pub fn build(self) -> ProgressEvent

Builds the progress event.

Returns

An immutable ProgressEvent with the configured values.

Trait Implementations

impl Clone for ProgressEventBuilder

fn clone(&self) -> ProgressEventBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressEventBuilder

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

Formats the value using the given formatter.

impl Default for ProgressEventBuilder

fn default() -> Self

Creates a builder with default running progress state.

Returns

A builder equivalent to Self::new.

impl PartialEq for ProgressEventBuilder

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