Struct ProgressParams 

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

Progress notification params.

Sent from server to client to report progress on a long-running operation.

Fields

progress_token: ProgressToken

Progress token (from original request’s _meta.progressToken).

progress: f64

Progress value (0.0 to 1.0, or absolute values for indeterminate progress).

total: Option<f64>

Total expected progress (optional, for determinate progress).

message: Option<String>

Optional progress message describing current status.

Implementations

impl ProgressParams

pub fn new(token: impl Into<ProgressToken>, progress: f64) -> Self

Creates a new progress notification.

pub fn with_total( token: impl Into<ProgressToken>, progress: f64, total: f64, ) -> Self

Creates a progress notification with total (determinate progress).

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

Adds a message to the progress notification.

pub fn fraction(&self) -> Option<f64>

Returns the progress as a fraction (0.0 to 1.0) if total is known.

Trait Implementations

impl Clone for ProgressParams

fn clone(&self) -> ProgressParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgressParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.