Struct ProgressMetricSnapshot 

pub struct ProgressMetricSnapshot { /* private fields */ }

Snapshot of one metric counter within a progress event.

A progress event may carry multiple counters using different metric units, such as entries and bytes. ProgressMetricSnapshot flattens one counter together with the event-level phase, stage, and elapsed time so formatters and consumers can handle one metric record at a time.

Implementations

impl ProgressMetricSnapshot

pub fn new( metric: ProgressMetric, phase: ProgressPhase, stage: Option<ProgressStage>, counter: &ProgressCounter, elapsed: Duration, ) -> Self

Creates a metric snapshot from explicit values.

Parameters

• metric - Complete metric metadata.
• phase - Lifecycle phase inherited from the source event.
• stage - Optional stage inherited from the source event.
• counter - Counter values copied into the snapshot.
• elapsed - Elapsed duration inherited from the source event.

Returns

A flattened metric snapshot.

pub const fn metric(&self) -> &ProgressMetric

Returns the complete metric metadata.

Returns

The metric metadata associated with this snapshot.

pub fn metric_id(&self) -> &str

Returns the stable metric id.

Returns

The metric id associated with this snapshot.

pub fn metric_name(&self) -> &str

Returns the human-readable metric name.

Returns

The metric display name associated with this snapshot.

pub const fn phase(&self) -> ProgressPhase

Returns the lifecycle phase.

Returns

The phase inherited from the source event.

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

Returns the optional stage.

Returns

Some(stage) when the source event carried stage metadata, otherwise None.

pub const fn total_count(&self) -> Option<u64>

Returns the total work-unit count when known.

Returns

Some(total) for known-total progress, or None for open-ended progress.

pub const fn completed_count(&self) -> u64

Returns the completed work-unit count.

Returns

The number of completed work units.

pub const fn active_count(&self) -> u64

Returns the active work-unit count.

Returns

The number of currently active work units.

pub const fn succeeded_count(&self) -> u64

Returns the successful work-unit count.

Returns

The number of successful work units.

pub const fn failed_count(&self) -> u64

Returns the failed work-unit count.

Returns

The number of failed work units.

pub const fn remaining_count(&self) -> Option<u64>

Returns the remaining work-unit count when the total is known.

Returns

Some(total - completed - active) using saturating arithmetic for known-total progress, or None when the total is unknown.

pub fn progress_fraction(&self) -> Option<f64>

Returns completed progress as a fraction in 0.0..=1.0.

Returns

Some(fraction) for known-total progress, Some(1.0) when the known total is zero, or None when the total is unknown.

pub fn progress_percent(&self) -> Option<f64>

Returns completed progress as a percentage in 0.0..=100.0.

Returns

Some(percent) for known-total progress, or None when the total is unknown.

pub const fn elapsed(&self) -> Duration

Returns the elapsed duration.

Returns

The elapsed duration inherited from the source event.

Trait Implementations

impl Clone for ProgressMetricSnapshot

fn clone(&self) -> ProgressMetricSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressMetricSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressMetricSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProgressMetricSnapshot

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProgressMetricSnapshot