Struct ProgressUpdater

pub struct ProgressUpdater { /* private fields */ }

Available on crate feature std only.

A handle for updating progress during execution of a future.

This struct allows you to report progress updates that will be broadcast to listeners via the progress stream. It maintains internal state and automatically handles cancellation when dropped.

Implementations

impl ProgressUpdater

pub fn update_with_message(&mut self, current: u64, message: impl Into<String>)

Updates the progress with the given current value and message.

This will broadcast the update to all progress stream listeners.

pub fn update(&mut self, current: u64)

Updates the progress with the given current value.

This will broadcast the update to all progress stream listeners.

pub fn pause(&self)

Pauses the progress operation.

This method sets the progress state to paused and broadcasts the update to all listeners.

pub fn complete(&mut self)

Marks the progress operation as completed.

This method sets the completed flag and broadcasts a completion update. Subsequent calls to this method have no effect.

pub fn pause_with_message(&self, message: impl Into<String>)

Pauses the progress operation with a descriptive message.

This method sets the progress state to paused and broadcasts the update to all listeners.

pub fn set_total(&mut self, total: u64)

Updates the total expected value for the progress operation.

This method changes the total value and broadcasts an update with the current progress.

pub fn cancel(self)

Cancels the progress operation.

Trait Implementations

impl Clone for ProgressUpdater

fn clone(&self) -> ProgressUpdater

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressUpdater

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

Formats the value using the given formatter.

impl Drop for ProgressUpdater

fn drop(&mut self)

Executes the destructor for this type.