Struct ProgressEventBuilder 

pub struct ProgressEventBuilder { /* private fields */ }

Builder for ProgressEvent.

The builder keeps the common path compact by carrying the event schema and letting callers append named metric counters with a closure.

Examples

use std::time::Duration;

use qubit_progress::{
    ProgressEvent,
    ProgressMetric,
    ProgressPhase,
    ProgressSchema,
};

let schema = ProgressSchema::new(vec![ProgressMetric::new("bytes", "Bytes")]);
let event = ProgressEvent::builder(schema)
    .running()
    .counter("bytes", |counter| counter.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.counter("bytes").map(|c| c.completed_count()), Some(3));
assert_eq!(event.stage().map(|stage| stage.id()), Some("copy"));

Implementations

impl ProgressEventBuilder

pub fn new(schema: ProgressSchema) -> Self

Creates a builder for a schema.

Parameters

• schema - Metric schema carried by the built event.

Returns

A builder whose phase is ProgressPhase::Running, elapsed duration is zero, and counters are empty.

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 fn counters(self, counters: Vec<ProgressCounter>) -> Self

Replaces the current counter list.

Parameters

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

Returns

This builder with counters recorded.

pub fn counter<F>(self, metric_id: &str, configure: F) -> Self

where F: FnOnce(ProgressCounter) -> ProgressCounter,

Appends one configured counter.

Parameters

• metric_id - Metric identifier for the counter.
• configure - Closure that fills the counter values.

Returns

This builder with the configured counter appended.

pub fn add_counter(self, counter: ProgressCounter) -> Self

Appends a prebuilt counter.

Parameters

• counter - Counter to append.

Returns

This builder with counter appended.

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 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