Struct McpProgressPayload 

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

Progress notification payload compatible with the MCP specification’s notifications/progress message shape.

Every field maps 1-to-1 to the MCP JSON payload so that ipckit progress events can be forwarded verbatim to any MCP gateway (Claude, OpenAI Agents SDK, Cursor, Cline, …) without a translation layer.

Schema

{
  "progressToken": "task-uuid",
  "progress": 42.0,
  "total": 100.0,
  "message": "Rendering frame 42/100"
}

Fields

progress_token: String

Opaque token that identifies the in-progress operation.

Consumers MUST treat this as an opaque string; its internal structure is defined by the producer.

progress: f64

How much of the work has been completed so far.

The unit is left to the producer; it is only meaningful relative to total when that field is present.

total: Option<f64>

Total amount of work, if known.

None signals an indeterminate operation (spinner, not progress bar).

message: Option<String>

Human-readable status message.

Implementations

impl McpProgressPayload

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

Create a new MCP progress payload.

Arguments

• progress_token – opaque identifier for the in-progress operation.
• progress – units of work completed so far.
• total – total units of work, or None for indeterminate progress.
• message – optional human-readable status string.

Trait Implementations

impl Clone for McpProgressPayload

fn clone(&self) -> McpProgressPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McpProgressPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for McpProgressPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for McpProgressPayload

fn eq(&self, other: &McpProgressPayload) -> 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 McpProgressPayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for McpProgressPayload