Struct ProgressCounter 

pub struct ProgressCounter { /* private fields */ }

Counters for one metric in a progress event.

A counter is identified by metric_id. The corresponding display name and metric dictionary entry live in ProgressSchema. Counter values are u64 so they can represent domain quantities such as bytes, records, objects, or files independently of the current platform’s pointer width.

Examples

use qubit_progress::ProgressCounter;

let counter = ProgressCounter::new("bytes")
    .total(10_000)
    .completed(4_000)
    .active(1);

assert_eq!(counter.metric_id(), "bytes");
assert_eq!(counter.total_count(), Some(10_000));
assert_eq!(counter.progress_percent(), Some(40.0));

Implementations

impl ProgressCounter

pub fn new(metric_id: &str) -> Self

Creates a counter for a metric with an unknown total count.

Parameters

• metric_id - Metric identifier declared by the progress schema.

Returns

A zeroed counter associated with metric_id.

pub const fn with_total_count(self, total_count: Option<u64>) -> Self

Returns a copy configured with the known or unknown total count.

Parameters

• total_count - Total work-unit count, or None when unknown.

Returns

This counter with total_count recorded.

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

Returns a copy configured with a known total count.

Parameters

• total_count - Total work-unit count.

Returns

This counter with a known total count.

pub const fn unknown_total(self) -> Self

Returns a copy configured with an unknown total count.

Returns

This counter with no total count.

pub const fn with_completed_count(self, completed_count: u64) -> Self

Returns a copy configured with the completed count.

Parameters

• completed_count - Number of completed work units.

Returns

This counter with completed_count recorded.

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

Returns a copy configured with the completed count.

Parameters

• completed_count - Number of completed work units.

Returns

This counter with completed_count recorded.

pub const fn with_active_count(self, active_count: u64) -> Self

Returns a copy configured with the active count.

Parameters

• active_count - Number of currently active work units.

Returns

This counter with active_count recorded.

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

Returns a copy configured with the active count.

Parameters

• active_count - Number of currently active work units.

Returns

This counter with active_count recorded.

pub const fn with_succeeded_count(self, succeeded_count: u64) -> Self

Returns a copy configured with the succeeded count.

Parameters

• succeeded_count - Number of successful work units.

Returns

This counter with succeeded_count recorded.

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

Returns a copy configured with the succeeded count.

Parameters

• succeeded_count - Number of successful work units.

Returns

This counter with succeeded_count recorded.

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

Returns a copy configured with the failed count.

Parameters

• failed_count - Number of failed work units.

Returns

This counter with failed_count recorded.

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

Returns a copy configured with the failed count.

Parameters

• failed_count - Number of failed work units.

Returns

This counter with failed_count recorded.

pub fn metric_id(&self) -> &str

Returns the metric identifier.

Returns

The id of the metric this counter reports.

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.

Trait Implementations

impl Clone for ProgressCounter

fn clone(&self) -> ProgressCounter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressCounter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressCounter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProgressCounter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProgressCounter

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProgressCounter

impl StructuralPartialEq for ProgressCounter