Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cloneable cancellation signal. Every clone observes the same state, and cancelling is idempotent - a token that fires twice (say, a cancel racing a reap) is not an error.

Implementations

impl CancelToken

pub fn new() -> Self

A fresh, un-cancelled token.

pub fn cancel(&self)

Fire the signal, waking every waiter. Idempotent.

pub fn is_cancelled(&self) -> bool

Whether this token has already fired.

pub async fn cancelled(&self)

Resolve once the token fires, immediately if it already has.

The waiter is armed before the flag is re-checked. notify_waiters only wakes waiters registered at the time it runs, so checking first and waiting second would lose a cancel that landed in between - and the job would then run to completion despite having been 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 Debug for CancelToken

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

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.