Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A token that can be used to check for, wait on, or request cancellation

Cloned tokens share the same underlying signal: cancelling any clone cancels them all. Backed by tokio_util::sync::CancellationToken, so cancellation can also be awaited via cancelled.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a new, un-cancelled token

pub fn is_cancelled(&self) -> bool

Check if cancellation has been requested

pub fn cancel(&self)

Request cancellation

pub async fn cancelled(&self)

Wait until cancellation is requested

Completes immediately if the token is already 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() -> CancellationToken

Returns the “default value” for a type.