Struct ProgressToken

pub struct ProgressToken<S> { /* private fields */ }

A token that tracks the progress of a task and can be organized hierarchically

Implementations

impl<S: Clone + Send + 'static> ProgressToken<S>

pub fn new(status: impl Into<S>) -> Self

Create a new root ProgressToken

pub fn child(&self, weight: f64, status: impl Into<S>) -> Self

Create a child token

pub fn update_progress(&self, progress: f64)

Update the progress of this token

pub fn update_indeterminate(&self)

Set the progress state to indeterminate

pub fn update_status(&self, status: impl Into<S>)

Update the status message

pub fn update(&self, progress: Progress, status: impl Into<S>)

Update the progress and status message

pub fn complete(&self)

Mark the task as complete

pub fn check(&self) -> Result<(), ProgressError>

Returns ProgressError::Cancelled if the token is cancelled, otherwise Ok.

pub fn is_cancelled(&self) -> bool

pub fn cancel(&self)

Cancel this task and all its children

pub fn state(&self) -> Progress

Get the current progress state asynchronously

pub fn statuses(&self) -> Vec<S>

Get all status messages in this hierarchy asynchronously

pub fn cancelled(&self) -> WaitForCancellationFuture<'_>

pub fn cancelled_owned(self) -> WaitForCancellationFutureOwned

pub async fn updated(&self) -> Result<ProgressUpdate<S>, ProgressError>

pub fn subscribe(&self) -> ProgressStream<'_, S>

Subscribe to progress updates from this token

pub fn complete_guard(&self) -> CompleteGuard<'_, S>

Creates a guard that will automatically mark this token as complete when dropped

Trait Implementations

impl<S: Clone> Clone for ProgressToken<S>

fn clone(&self) -> ProgressToken<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for ProgressToken<S>

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

Formats the value using the given formatter.

impl<S: Default + Clone + Send + 'static> Default for ProgressToken<S>

fn default() -> Self

Returns the “default value” for a type.