Struct ProgressSnapshot 

pub struct ProgressSnapshot {
    pub kind: ProgressType,
    pub name: CompactString,
    pub item: CompactString,
    pub elapsed: Option<Duration>,
    pub position: u64,
    pub total: u64,
    pub finished: bool,
    pub error: Option<CompactString>,
}

A plain-data snapshot of a Progress state at a specific point in time.

This is typically used for rendering, as it holds owned data and requires no locking to access.

Fields

kind: ProgressType

The type of progress indicator.

name: CompactString

The name/label of the progress task.

item: CompactString

The current item description.

elapsed: Option<Duration>

The elapsed duration.

position: u64

The current position.

total: u64

The total target count.

finished: bool

Whether the task is finished.

error: Option<CompactString>

The associated error message, if any.

Implementations

impl ProgressSnapshot

pub const fn kind(&self) -> ProgressType

Returns the type of progress indicator.

pub fn name(&self) -> &str

Returns the name/label of the progress task.

pub fn item(&self) -> &str

Returns the current item description.

pub const fn elapsed(&self) -> Option<Duration>

Returns the elapsed duration.

pub const fn position(&self) -> u64

Returns the current position.

pub const fn total(&self) -> u64

Returns the total target count.

pub const fn finished(&self) -> bool

Returns whether the task is finished.

pub fn error(&self) -> Option<&str>

Returns the error message, if any.

pub fn eta(&self) -> Option<Duration>

Estimates the time remaining (ETA) based on average speed since start.

Returns None if:

• No progress has been made.
• Total is zero.
• Process is finished.
• Elapsed time is effectively zero.

pub fn throughput(&self) -> f64

Calculates the average throughput (items per second) over the entire lifetime.

pub fn throughput_since(&self, prev: &Self) -> f64

Calculates the instantaneous throughput relative to a previous snapshot.

This is useful for calculating “current speed” (e.g., in the last second).

Trait Implementations

impl Clone for ProgressSnapshot

fn clone(&self) -> ProgressSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressSnapshot

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

Formats the value using the given formatter.

impl Default for ProgressSnapshot

fn default() -> ProgressSnapshot

Returns the “default value” for a type.

impl From<&Progress> for ProgressSnapshot

fn from(progress: &Progress) -> Self

Converts to this type from the input type.

impl PartialEq for ProgressSnapshot

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

impl StructuralPartialEq for ProgressSnapshot