Struct Cancellation 

pub struct Cancellation { /* private fields */ }

Explicit cancellation authority and observer for one lifetime.

There is deliberately no global token or ambient lookup. Hosts construct a root, derive children for owned work, and pass those values explicitly.

Implementations

impl Cancellation

pub fn new() -> Self

Constructs an open, independent cancellation lifetime.

pub fn child(&self) -> Self

Constructs an open child which follows this token’s terminal state.

pub fn cancel(&self, reason: CancellationReason) -> bool

Performs the sole open-to-cancelled transition, returning true only to its winner.

pub fn reason(&self) -> Option<CancellationReason>

Observes the terminal reason without blocking.

pub fn is_cancelled(&self) -> bool

Returns whether the terminal transition has occurred.

pub fn cancelled(&self) -> CancellationWaiter

Registers an executor-neutral waiter for the terminal reason.

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() -> Self

Returns the “default value” for a type.