Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A cooperative cancellation token.

Supports both synchronous polling (is_cancelled()) and async waiting (cancelled()). The async path uses tokio::select! in streaming loops to interrupt mid-stream without waiting for the next token.

Implementations

impl CancellationToken

pub fn new() -> CancellationToken

pub fn new_pair() -> (CancellationHandle, CancellationToken)

Create a split pair: a write-only handle and a read-only token.

Useful when the cancellation signal sender and the receiver should be passed to different components independently.

pub fn cancel(&self)

Signal cancellation. Wakes all async waiters immediately.

pub fn is_cancelled(&self) -> bool

Check if cancellation has been requested (synchronous poll).

pub async fn cancelled(&self)

Wait until cancellation is signalled. Resolves immediately if 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 Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.