Struct ProgressEvent 

pub struct ProgressEvent { /* private fields */ }

Immutable progress event delivered to reporters.

Examples

use std::time::Duration;

use qubit_progress::{
    ProgressCounters,
    ProgressEvent,
    ProgressPhase,
    ProgressStage,
};

let counters = ProgressCounters::new(Some(5)).with_completed_count(2);
let event = ProgressEvent::from_phase(
    ProgressPhase::Running,
    counters,
    Duration::from_millis(500),
)
.with_stage(ProgressStage::new("load", "Load records"));

assert_eq!(event.phase(), ProgressPhase::Running);
assert_eq!(event.counters().completed_count(), 2);
assert_eq!(event.stage().map(|stage| stage.name()), Some("Load records"));

Implementations

impl ProgressEvent

pub const fn builder() -> ProgressEventBuilder

Creates a progress event builder.

Returns

A builder initialized as running, unknown-total progress with zeroed counters and zero elapsed time.

pub fn new(builder: ProgressEventBuilder) -> Self

Creates a progress event.

Parameters

• builder - Builder containing configured event fields.

Returns

A progress event built from builder.

pub const fn started(counters: ProgressCounters, elapsed: Duration) -> Self

Creates a started progress event.

Parameters

• counters - Initial progress counters.
• elapsed - Elapsed duration at start, usually zero.

Returns

A progress event with ProgressPhase::Started.

pub const fn running(counters: ProgressCounters, elapsed: Duration) -> Self

Creates a running progress event.

Parameters

• counters - Current progress counters.
• elapsed - Elapsed duration since operation start.

Returns

A progress event with ProgressPhase::Running.

pub const fn finished(counters: ProgressCounters, elapsed: Duration) -> Self

Creates a finished progress event.

Parameters

• counters - Final progress counters.
• elapsed - Total elapsed duration.

Returns

A progress event with ProgressPhase::Finished.

pub const fn failed(counters: ProgressCounters, elapsed: Duration) -> Self

Creates a failed progress event.

Parameters

• counters - Final or current progress counters.
• elapsed - Elapsed duration at failure.

Returns

A progress event with ProgressPhase::Failed.

pub const fn canceled(counters: ProgressCounters, elapsed: Duration) -> Self

Creates a canceled progress event.

Parameters

• counters - Final or current progress counters.
• elapsed - Elapsed duration at cancellation.

Returns

A progress event with ProgressPhase::Canceled.

pub const fn from_phase( phase: ProgressPhase, counters: ProgressCounters, elapsed: Duration, ) -> Self

Creates a progress event for the supplied lifecycle phase.

Parameters

• phase - Lifecycle phase for the event.
• counters - Progress counters carried by the event.
• elapsed - Elapsed duration carried by the event.

Returns

A progress event with phase, counters, and elapsed.

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

Returns a copy configured with the current stage.

Parameters

• stage - Current operation stage.

Returns

This event with stage recorded.

pub const fn phase(&self) -> ProgressPhase

Returns the event phase.

Returns

The lifecycle phase carried by this event.

pub const fn stage(&self) -> Option<&ProgressStage>

Returns the current stage when known.

Returns

Some(stage) when this event carries stage information, otherwise None.

pub const fn counters(&self) -> ProgressCounters

Returns the progress counters.

Returns

The counters carried by this event.

pub const fn elapsed(&self) -> Duration

Returns the elapsed duration.

Returns

The monotonic elapsed duration carried by this event.

Trait Implementations

impl Clone for ProgressEvent

fn clone(&self) -> ProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressEvent

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

Formats the value using the given formatter.

impl PartialEq for ProgressEvent

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