Struct CancellationToken 

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

Hierarchical cancellation flag. Cancelling a parent cancels every child; cancelled resolves without polling.

Implementations

impl CancellationToken

pub fn cancel(&self)

Cancel this token and every child.

pub fn is_cancelled(&self) -> bool

Whether this token or an ancestor was cancelled.

pub fn child(&self) -> Self

A child token cancelled with its parent.

pub fn cancelled(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>

Resolves once this token or any ancestor is cancelled.

Trait Implementations

impl Clone for CancellationToken

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 CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.