Struct CancelToken 

pub struct CancelToken { /* private fields */ }

Shared cancel flag. Clones observe the same flag.

Implementations

impl CancelToken

pub fn new() -> Self

pub fn from_flag(flag: Arc<AtomicBool>) -> Self

Adopt an existing flag: the token observes (and sets) that same Arc, so a caller that already owns a cancel flag (for example a task guard) shares it instead of copying it.

pub fn flag(&self) -> &Arc<AtomicBool>

The shared flag itself, to hand to code that owns an Arc<AtomicBool>.

pub fn cancel(&self)

Request cancellation. Calls in flight stop at their next check point.

pub fn is_cancelled(&self) -> bool

pub fn as_atomic(&self) -> &AtomicBool

The underlying flag, for APIs that take &AtomicBool.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> Self

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

Returns the “default value” for a type.