Struct CancellationToken 

pub struct CancellationToken(/* private fields */);

Cooperative cancellation handle. Clone is cheap (just an Arc).

is_cancelled() is a non-blocking check that providers can poll between chunks of work. cancelled() returns a future that resolves the moment cancellation flips, suitable for tokio::select! or futures::select! against an upstream operation.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a fresh, un-cancelled token.

pub fn cancel(&self)

Flip the cancellation flag and wake every pending cancelled() future. Idempotent — calling twice is harmless.

pub fn is_cancelled(&self) -> bool

Non-blocking check — returns true once cancel() has been called.

pub fn cancelled(&self) -> Cancelled<'_>

Future that resolves when cancellation flips. Pending until then. Cheap to construct; stores at most one waker per polling task.

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.