Struct ProgressReporter 

pub struct ProgressReporter { /* private fields */ }

A handle that long-running tool handlers call to emit progress notifications during their work. Wraps the crate::mcp_session::SessionState that owns the broadcast channel

• replay buffer; calls into SessionState::publish_event for the actual fan-out.

Cloneable so handlers can move it across tokio::spawn boundaries (the underlying Arc<SessionState> + token clone are cheap).

Constructed only when the dispatch path has BOTH an attached Arc<SessionState> AND a parsed _meta.progressToken. Callers (dispatch_tool + downstream handlers) accept Option<ProgressReporter> and skip reporting silently when it’s None.

Implementations

impl ProgressReporter

pub fn new(session: Arc<SessionState>, token: ProgressToken) -> Self

Build a reporter wired to a session + the client’s token. Sole caller today is McpDispatcher::handle_tools_call (and tests).

pub fn token(&self) -> &ProgressToken

Echo the original wire-shape token back to the client. Used by the GET stream sink to correlate progress events with in-flight tools/call requests on the JSON-RPC reply side.

pub fn report( &self, progress: u64, total: Option<u64>, message: Option<&str>, ) -> u64

Publish one notifications/progress envelope to the session’s event stream. The envelope:

{
  "jsonrpc": "2.0",
  "method": "notifications/progress",
  "params": {
    "progressToken": <client's original token>,
    "progress": <current>,
    "total": <expected total or null>,
    "message": <optional human-readable string or null>
  }
}

Returns the per-session event id assigned by SessionState::publish_event so callers can correlate the emit with the resulting stream entry. Lossy on the broadcast side (no live subscriber = silent drop) but lossless to the replay buffer.

Trait Implementations

impl Clone for ProgressReporter

fn clone(&self) -> ProgressReporter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressReporter

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

Formats the value using the given formatter.