Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A hierarchical cancellation token.

Cancelling a parent is visible to all descendants. Cancelling a child does not affect its parent or siblings.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates an uncancelled root token.

pub fn child_token(&self) -> Self

Creates a child token linked to this token.

pub fn cancel(&self)

Cancels this token and, transitively, its descendants.

pub fn is_cancelled(&self) -> bool

Returns whether this token has been cancelled.

pub async fn cancelled(&self)

Waits until this token or one of its ancestors is cancelled.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

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.