Struct CancelToken 

pub struct CancelToken(/* private fields */);

A cloneable cancellation flag. Every clone observes the same flag, so the owner of a job keeps one clone and hands others to the lanes working on it.

Cancellation is one-way: once raised it stays raised for the token’s lifetime.

Implementations

impl CancelToken

pub fn new() -> Self

A fresh, not-yet-cancelled token.

pub fn cancel(&self)

Raises the flag for every clone of this token.

pub fn is_cancelled(&self) -> bool

Whether Self::cancel has been called on any clone.

pub fn as_flag(&self) -> &AtomicBool

The underlying flag, for code that takes a plain &AtomicBool (the export’s existing dispatch helpers, the tracer’s cancellable entry points).

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.