Struct CancellationTokenSource 

pub struct CancellationTokenSource { /* private fields */ }

A source that can cancel associated CancellationTokens.

Cancellation is cooperative and single-threaded. When cancelled:

• All registered FnOnce callbacks are called (in registration order).
• All futures waiting via CancellationToken::cancelled() are woken.

Example

use async_cancellation_token::CancellationTokenSource;

let cts = CancellationTokenSource::new();
let token = cts.token();

assert!(!cts.is_cancelled());
cts.cancel();
assert!(cts.is_cancelled());

Implementations

impl CancellationTokenSource

pub fn new() -> Self

Create a new CancellationTokenSource.

pub fn token(&self) -> CancellationToken

Get a CancellationToken associated with this source.

pub fn cancel(&self)

Cancel all associated tokens.

This marks the source as cancelled. After cancellation:

• All registered callbacks are called exactly once.
• All waiting futures are woken.

Note: Cancellation is idempotent; calling this method multiple times has no effect. FnOnce callbacks will only be called once.

Single-threaded only. Not safe to call concurrently from multiple threads.

pub fn is_cancelled(&self) -> bool

Check if this source has been cancelled.

Trait Implementations

impl Clone for CancellationTokenSource

fn clone(&self) -> CancellationTokenSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancellationTokenSource

fn default() -> Self

Returns the “default value” for a type.