Skip to main content

ProgressTracker

Struct ProgressTracker 

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

A helper for sending progress updates for a long-running operation.

This wraps a NotificationSender and an optional progress token, making it easy to report progress without checking if the token is present each time.

Implementations§

Source§

impl ProgressTracker

Source

pub fn new(notifier: NotificationSender, token: Option<ProgressToken>) -> Self

Create a new progress tracker.

If token is None, all progress updates will be no-ops.

Source

pub fn from_meta(notifier: NotificationSender, meta: Option<&Value>) -> Self

Create a tracker from a request’s _meta.progressToken.

Extracts the progress token from the _meta field of a request params object.

Source

pub async fn update(&self, progress: f64, total: f64, message: Option<String>)

Send a progress update.

  • progress: Current progress value
  • total: Total value (progress/total gives percentage)
  • message: Optional status message

Returns silently if no progress token was provided.

Source

pub async fn update_percent(&self, percent: f64, message: Option<String>)

Send a progress update with just a percentage (0.0 to 1.0).

Source

pub async fn update_with_message( &self, progress: f64, total: f64, message: impl Into<String>, )

Send a progress update with a message.

Source

pub async fn complete(&self, message: impl Into<String>)

Mark the operation as complete with a final message.

Source

pub fn is_tracking(&self) -> bool

Check if progress tracking is enabled (token was provided).

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<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: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,