Struct Cancel 

pub struct Cancel { /* private fields */ }

A handle for stopping a run from another thread.

Cheap to clone (one Arc), which is the point: the thread running the task holds one, and so does whatever is listening for the request to stop.

Implementations

impl Cancel

pub fn new() -> Self

pub fn cancel(&self)

Stop the run: signal whatever is running now, and refuse to start any further step.

Idempotent, and safe to call when nothing is running (a run cancelled between steps simply never starts the next one).

pub fn is_cancelled(&self) -> bool

Whether cancel has been called.

Trait Implementations

impl Clone for Cancel

fn clone(&self) -> Cancel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cancel

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

Formats the value using the given formatter.

impl Default for Cancel

fn default() -> Cancel

Returns the “default value” for a type.