Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cooperative cancellation shared by one Module Instance generation.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates a token that has not been cancelled.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

pub fn cancelled(&self) -> LocalBoxFuture<'static, ()>

Waits until cancellation is requested.

pub fn cancel(&self)

Requests cooperative cancellation and wakes every current waiter.

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.