Struct CancellationToken

pub struct CancellationToken { /* private fields */ }

A token which listens for a cancellation signal from a TokenCanceller.

Implementations

impl CancellationToken

pub fn is_cancelled(&self) -> bool

Checks whether the cancellation signal has been given.

pub fn wait( &self, ) -> Shared<Pin<Box<dyn Future<Output = Result<(), Canceled>> + Send>>>

Returns a future which only resolves once the cancellation signal has been given.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a copy 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.