Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A clonable cancellation handle. Clones share one underlying flag, so a worker thread can hold a clone and cancel a run executing on another thread.

Implementations

impl CancelToken

pub fn new() -> Self

A fresh, un-cancelled token.

pub fn cancel(&self)

Request cancellation of the run/stream this token is installed on.

pub fn is_cancelled(&self) -> bool

Whether cancellation has been requested.

pub fn reset(&self)

Clear the cancelled state so the token can be reused for another run.

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.