Struct Cancellation 

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

A flag a caller can raise to stop a running child early.

Deliberately not a channel or a future: the one caller is a synchronous provisioning transaction that wants to abandon a wsl.exe invocation when the operator hits Ctrl-C, and a shared boolean is the whole of that requirement. Cloning shares the flag.

Implementations

impl Cancellation

pub fn new() -> Self

A flag that has not been raised.

pub fn cancel(&self)

Raises it. Every request holding a clone is killed at the next poll.

pub fn is_cancelled(&self) -> bool

Whether it has been raised.

Trait Implementations

impl Clone for Cancellation

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 Cancellation

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

Formats the value using the given formatter.

impl Default for Cancellation

fn default() -> Self

Returns the “default value” for a type.