Struct TaskProgress 

pub struct TaskProgress {
    pub processed: u64,
    pub total: Option<u64>,
    pub unit: ProgressUnit,
}

Progress counters for a running task.

Fields

processed: u64

Number of items processed so far.

total: Option<u64>

Total number of items, if known.

unit: ProgressUnit

The unit of measurement.

Implementations

impl TaskProgress

pub fn new(unit: ProgressUnit) -> Self

Create a new progress tracker with zero items processed.

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

Returns the completion fraction in [0.0, 1.0], or None if the total is unknown or zero.

Counters above 2^52 lose precision in the conversion, which is acceptable for a display fraction.

pub fn aggregate<'a>( progress: impl IntoIterator<Item = &'a TaskProgress>, ) -> Option<Self>

Aggregate progress counters with the same unit.

Returns None when the iterator is empty or when any item uses a different unit. Unknown totals are preserved: if any child total is unknown then the aggregate total is unknown.

Trait Implementations

impl Clone for TaskProgress

fn clone(&self) -> TaskProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskProgress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TaskProgress

impl PartialEq for TaskProgress

fn eq(&self, other: &TaskProgress) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TaskProgress

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 TaskProgress