Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A token that can be used to signal cancellation of a long-running operation.

Clones share the same underlying cancellation state — cancelling one clone cancels all of them.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates a new, uncancelled token.

pub fn cancel(&self)

Signals cancellation.

All clones of this token will become cancelled.

pub fn is_cancelled(&self) -> bool

Returns true if cancellation has been signaled.

pub async fn cancelled(&self)

Returns a future that resolves when cancellation is signaled.

Uses tokio::sync::Notify-style polling. This is a lightweight check — it does not block a thread.

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.