Struct ProgressUpdate 

#[non_exhaustive]
pub struct ProgressUpdate {
    pub token: String,
    pub message: String,
    pub percentage: Option<u32>,
    pub done: bool,
}

One progress step.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

token: String

Token identifying the progress stream.

message: String

Human-readable message.

percentage: Option<u32>

Optional [0, 100] percentage.

done: bool

true when this is the final update for the stream.

Implementations

impl ProgressUpdate

pub fn new( token: impl Into<String>, message: impl Into<String>, percentage: Option<u32>, ) -> Self

Construct an in-progress update.

pub fn final_update( token: impl Into<String>, message: impl Into<String>, ) -> Self

Construct a final update with percentage of 100.

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.