Struct Cancellation 

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

A cancellation flag shared with whoever may cancel the run.

Cloning shares the same underlying flag: cancelling one handle cancels every clone, including ones already handed to a Budget.

Implementations

impl Cancellation

pub fn new() -> Self

A fresh, not-yet-cancelled flag.

pub fn cancel(&self)

Requests cancellation. Idempotent: cancelling twice is the same as cancelling once.

pub fn is_cancelled(&self) -> bool

Whether Cancellation::cancel has been called on this flag or any clone of it.

Trait Implementations

impl Clone for Cancellation

fn clone(&self) -> Cancellation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cancellation

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

Formats the value using the given formatter.

impl Default for Cancellation

fn default() -> Cancellation

Returns the “default value” for a type.