Struct ProgressUpdate 

pub struct ProgressUpdate { /* private fields */ }

Represents a single progress update with current status, total, and optional metadata.

This struct contains all the information about the current state of a progress-tracked operation. It is emitted by progress streams and provides methods to query the current progress state.

You typically don’t create instances of this struct directly. Instead, use the progress function to create progress-tracked tasks, and receive ProgressUpdate instances from the progress stream.

Implementations

impl ProgressUpdate

pub const fn new( total: u64, current: u64, state: State, message: Option<String>, ) -> Self

Creates a new progress update.

This method is primarily used internally by the progress tracking system. Users should use the progress function instead of creating updates manually.

pub const fn total(&self) -> u64

Returns the total expected value when the operation will be complete.

pub const fn current(&self) -> u64

Returns the current progress value.

pub fn completed_fraction(&self) -> f64

Returns the completion fraction as a value between 0.0 and 1.0.

If the total is 0, returns 0.0. Otherwise, returns current/total.

pub const fn remaining(&self) -> u64

Returns the remaining progress (total - current).

Uses saturating subtraction, so if current > total, returns 0.

pub const fn is_cancelled(&self) -> bool

Returns true if the state is Cancelled.

pub const fn is_working(&self) -> bool

Returns true if the state is Working.

pub const fn is_completed(&self) -> bool

Returns true if the state is Completed.

pub const fn is_paused(&self) -> bool

Returns true if the state is Paused.

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

Returns the optional descriptive message about the current progress.

pub const fn state(&self) -> State

Returns the current state of the progress operation.

Trait Implementations

impl Clone for ProgressUpdate

fn clone(&self) -> ProgressUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressUpdate

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

Formats the value using the given formatter.

impl Hash for ProgressUpdate

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 Ord for ProgressUpdate

fn cmp(&self, other: &ProgressUpdate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProgressUpdate

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

fn partial_cmp(&self, other: &ProgressUpdate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ProgressUpdate

impl StructuralPartialEq for ProgressUpdate