Struct ProgressNotification 

#[non_exhaustive]
pub struct ProgressNotification {
    pub progress_token: ProgressToken,
    pub progress: f64,
    pub total: Option<f64>,
    pub message: Option<String>,
}

Progress notification.

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.

progress_token: ProgressToken

Progress token from the original request

progress: f64

Current progress value (must increase with each notification)

This can represent percentage (0-100), count, or any increasing metric.

total: Option<f64>

Optional total value for the operation

When combined with progress, allows expressing “5 of 10 items processed”. Both progress and total may be floating point values.

message: Option<String>

Optional human-readable progress message

Should provide relevant context about the current operation.

Implementations

impl ProgressNotification

pub fn new( progress_token: ProgressToken, progress: f64, message: Option<String>, ) -> Self

Create a new progress notification with no total value.

Convenience constructor to reduce boilerplate when the total is unknown.

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

Set the total value for the operation.

Trait Implementations

impl Clone for ProgressNotification

fn clone(&self) -> ProgressNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressNotification

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgressNotification

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.