Struct ProgressUpdate 

pub struct ProgressUpdate {
    pub token: ProgressToken,
    pub progress: f64,
    pub total: Option<f64>,
    pub message: Option<Cow<'static, str>>,
}

One progress update to put on the wire.

Fields

token: ProgressToken

The token the request carried.

progress: f64

How far along it is. Increases monotonically.

total: Option<f64>

How far along it has to be, when the handler knows.

message: Option<Cow<'static, str>>

An optional description of the current step.

Implementations

impl ProgressUpdate

pub const fn new(token: ProgressToken, progress: f64) -> Self

An update with a progress value and nothing else.

pub const fn with_total(self, total: f64) -> Self

Sets the total.

pub fn with_message(self, message: impl Into<Cow<'static, str>>) -> Self

Sets the message.

Trait Implementations

impl Clone for ProgressUpdate

fn clone(&self) -> Self

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProgressUpdate