Skip to main content

ProgressReporter

Struct ProgressReporter 

Source
pub struct ProgressReporter { /* private fields */ }
Expand description

Progress reporter that wraps a notification sender with a progress token.

This is the concrete type stored in McpContext that handles sending progress notifications with the correct token.

Implementations§

Source§

impl ProgressReporter

Source

pub fn new(sender: Arc<dyn NotificationSender>) -> Self

Creates a new progress reporter with the given sender.

Source

pub fn with_marker(marker: Value, sender: Arc<dyn NotificationSender>) -> Self

Creates a reporter which retains the request marker it will emit.

Proxy routes use this marker to correlate an upstream progress frame before relaying it through this request’s downstream reporter.

Source

pub fn marker(&self) -> Option<&Value>

Returns the request marker owned by this reporter, when it has one.

Source

pub fn report(&self, progress: f64, message: Option<&str>)

Reports progress to the client.

§Arguments
  • progress - Current progress value (0.0 to 1.0 for fractional, or absolute)
  • message - Optional message describing current status
Source

pub fn report_with_total( &self, progress: f64, total: f64, message: Option<&str>, )

Reports progress with a total for determinate progress bars.

§Arguments
  • progress - Current progress value
  • total - Total expected value
  • message - Optional message describing current status
Source

pub fn report_exact( &self, progress: Number, total: Option<Number>, message: Option<&str>, )

Reports final progress without converting JSON-number lexemes through f64.

The supplied numbers may exceed IEEE-754 range when the installed sender supports the final protocol. A legacy sender receives the trait default, which emits nothing.

Trait Implementations§

Source§

impl Clone for ProgressReporter

Source§

fn clone(&self) -> ProgressReporter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProgressReporter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V