Struct ProgressHandle 

pub struct ProgressHandle { /* private fields */ }

The connection-scoped handle for one work-done progress operation, created by Client::begin_progress.

The handle reports through ProgressHandle::report and finishes through ProgressHandle::end, which consumes it. Dropping an active handle removes its token from the connection’s registry and logs a warning, but performs no I/O: no implicit end notification is sent.

Implementations

impl ProgressHandle

pub fn token(&self) -> ProgressToken

The progress token allocated for this operation.

pub fn cancellation_token(&self) -> CancellationToken

The handle’s cancellation token.

User code may cancel it directly; the protocol engine’s window/workDoneProgress/cancel built-in cancels it when the user cancels a cancellable progress in the client UI. Cancellation never sends anything by itself: reports on a cancelled handle fail with ProgressError::Cancelled and the application still decides the final message and calls ProgressHandle::end.

pub fn report( &self, message: Option<String>, percentage: Option<u32>, ) -> Result<(), ClientError>

Enqueue one work-done report notification with the exact WorkDoneProgressReport shape: the handle’s cancellable flag plus the given message and percentage.

Errors

ClientError::Progress wrapping ProgressError::AlreadyEnded, ProgressError::Cancelled, or ProgressError::UnknownToken for a handle whose lifecycle already concluded, and ProgressError::InvalidPercentage for a percentage outside 0 through 100 — none of these send anything. Enqueue failures surface as the other ClientError variants.

pub fn end(self, message: Option<String>) -> Result<(), ClientError>

Enqueue one work-done end notification and remove the token from the connection’s registry, consuming the handle.

The token is removed after the enqueue whether it succeeded or failed, so the handle never leaks its registry entry. A cancelled handle still ends: cancellation never sends an implicit end by itself.

Errors

Enqueue failures surface as ClientError; the token is removed regardless.

Trait Implementations

impl Debug for ProgressHandle

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

Formats the value using the given formatter.

impl Drop for ProgressHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.