Struct ProgressNotificationParam 

pub struct ProgressNotificationParam {
    pub progress_token: ProgressToken,
    pub progress: f64,
    pub total: Option<f64>,
    pub message: Option<String>,
}

Fields

progress_token: ProgressToken

progress: f64

The progress thus far. This should increase every time progress is made, even if the total is unknown.

total: Option<f64>

Total number of items to process (or total progress required), if known

message: Option<String>

An optional message describing the current progress.

Implementations

impl ProgressNotificationParam

pub fn new( progress_token: ProgressToken, progress: f64, ) -> ProgressNotificationParam

Create a new ProgressNotificationParam with required fields.

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

Set the total number of items to process.

pub fn with_message( self, message: impl Into<String>, ) -> ProgressNotificationParam

Set a message describing the current progress.

Trait Implementations

impl Clone for ProgressNotificationParam

fn clone(&self) -> ProgressNotificationParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressNotificationParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressNotificationParam

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProgressNotificationParam, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProgressNotificationParam

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProgressNotificationParam

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProgressNotificationParam