Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cooperative cancellation token.

Cloning yields another handle to the same underlying flag, so cancelling any clone cancels them all. Tasks should poll CancelToken::is_cancelled at safe points or await CancelToken::cancelled.

Implementations

impl CancelToken

pub fn new() -> Self

Create a fresh, un-cancelled token.

pub fn cancel(&self)

Signal cancellation and wake all waiters.

pub fn is_cancelled(&self) -> bool

Whether cancellation has been requested.

pub async fn cancelled(&self)

Resolve once cancellation is requested. Returns immediately if already cancelled.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.