Struct CancellationToken

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

A shareable token to let you notify other tasks they should stop what they are doing and exit early.

Implementations

impl CancellationToken

pub fn new() -> CancellationToken

Create a new CancellationToken.

pub fn cancelled(&self) -> bool

Has this token already been cancelled?

pub fn cancel(&self)

Cancel the token, notifying anyone else listening that they should halt what they are doing.

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

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.