Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A token that can be used to signal cancellation.

Supports registering callbacks via on_cancel() that fire when the token is cancelled, enabling efficient waiting patterns.

Implementations

impl CancellationToken

pub fn new() -> Self

pub fn is_cancelled(&self) -> bool

pub fn cancel(&self)

pub fn on_cancel(&self, callback: Box<dyn FnOnce() + Send>)

Register a callback to be invoked when this token is cancelled. If already cancelled, the callback fires immediately.

This method is thread-safe: the callback is guaranteed to fire exactly once, either immediately (if already cancelled) or when cancel() is called.

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() -> CancellationToken

Returns the “default value” for a type.