Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A shared “stop now” flag.

Cloning is cheap and every clone refers to the same flag, so a transport can keep one and hand another to the run.

Implementations

impl CancellationToken

pub fn new() -> Self

A fresh, un-cancelled token.

pub fn cancel(&self)

Trips the token and wakes everything waiting on it.

Idempotent — cancelling twice is a no-op.

pub fn is_cancelled(&self) -> bool

Whether the token has been tripped.

pub fn cancelled(&self) -> Cancelled

Resolves once the token is tripped.

Use it to race an in-flight model call:

let token = CancellationToken::new();
token.cancel();
token.cancelled().await;

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.