Struct ProgressCounters 

pub struct ProgressCounters { /* private fields */ }

Generic progress counters for a running operation.

Examples

use qubit_progress::ProgressCounters;

let counters = ProgressCounters::new(Some(10))
    .with_completed_count(4)
    .with_active_count(2)
    .with_succeeded_count(3);

assert_eq!(counters.total_count(), Some(10));
assert_eq!(counters.remaining_count(), Some(4));
assert_eq!(counters.progress_percent(), Some(40.0));

Implementations

impl ProgressCounters

pub const fn new(total_count: Option<usize>) -> Self

Creates counters with a known or unknown total count.

Parameters

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

Returns

Zeroed counters with the supplied total count.

pub const fn with_total_count(self, total_count: Option<usize>) -> 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 set with total_count recorded.

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

Returns a copy configured with the completed count.

Parameters

• completed_count - Number of completed work units.

Returns

This counter set with completed_count recorded.

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

Returns a copy configured with the active count.

Parameters

• active_count - Number of currently active work units.

Returns

This counter set with active_count recorded.

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

Returns a copy configured with the succeeded count.

Parameters

• succeeded_count - Number of successful work units.

Returns

This counter set with succeeded_count recorded.

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

Returns a copy configured with the failed count.

Parameters

• failed_count - Number of failed work units.

Returns

This counter set with failed_count recorded.

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

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

Returns the completed work-unit count.

Returns

The number of completed work units.

pub const fn active_count(&self) -> usize

Returns the active work-unit count.

Returns

The number of currently active work units.

pub const fn succeeded_count(&self) -> usize

Returns the successful work-unit count.

Returns

The number of successful work units.

pub const fn failed_count(&self) -> usize

Returns the failed work-unit count.

Returns

The number of failed work units.

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

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 ProgressCounters

fn clone(&self) -> ProgressCounters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressCounters

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

Formats the value using the given formatter.

impl Hash for ProgressCounters

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 ProgressCounters

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

impl Eq for ProgressCounters

impl StructuralPartialEq for ProgressCounters