Struct CancelToken 

pub struct CancelToken { /* private fields */ }

Cooperative cancellation shared by a job and everything it starts.

Implementations

impl CancelToken

pub fn new() -> Self

Creates a token which has not been cancelled.

pub fn cancel(&self)

Cancels this token and all of its clones.

pub fn paced(&self, slice: Duration) -> CancelToken

Returns a token that shares cancellation and rests after each sustained slice of work. Clones of the returned token share the pacing state.

pub fn is_cancelled(&self) -> bool

Returns whether this token has been cancelled. Paced tokens may rest before reading the shared flag.

pub fn check(&self) -> Result<(), Cancelled>

Returns Err(Cancelled) once cancelled.

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.