Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A token that can be used to signal cancellation to an ongoing operation.

The token itself is immutable, but can be used to check if cancellation has been requested. When a cancellation is requested, all handlers checking this token should terminate early.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates a new cancellable token that is not yet cancelled.

pub fn is_cancelled(&self) -> bool

Returns true if cancellation has been requested.

pub fn cancel(&self)

Requests cancellation for this token.

This is idempotent - calling it multiple times has the same effect as calling it once.

pub fn was_cancellation_observed(&self) -> bool

Returns true once any poll has observed cancellation as requested.

pub fn cancellation_observation_latency(&self) -> Option<Duration>

Returns the first observed cancellation-poll latency from request to observation.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.