Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cloneable cancellation token.

Cancelling wakes every parked Gate::wait_until_cancellable carrying the token. By the handle-store protocol rule, cancellation fails parked reads; writes are not cancelled, so teardown writes can still land.

Implementations

impl CancelToken

pub fn new() -> Self

Create an un-cancelled token.

pub fn cancel(&self)

Cancel: wake all waiters. Idempotent.

pub fn is_cancelled(&self) -> bool

Whether the token has been cancelled.

pub async fn cancelled(&self)

Park until the token is cancelled.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.