Struct CancellationSource 

pub struct CancellationSource { /* private fields */ }

The control handle that triggers cancellation.

Dropping the source does not cancel the token — call cancel explicitly. This prevents accidental cancellation on scope exit.

Implementations

impl CancellationSource

pub fn new() -> Self

Create a new cancellation source with an uncancelled token.

pub fn token(&self) -> CancellationToken

Obtain a cloneable token that observes this source’s state.

pub fn cancel(&self)

Signal cancellation. All tokens derived from this source will observe is_cancelled() == true and any pending wait_timeout calls will wake.

pub fn is_cancelled(&self) -> bool

Check whether cancellation has already been requested.

Trait Implementations

impl Default for CancellationSource

fn default() -> Self

Returns the “default value” for a type.