Struct CancellationHandle 

pub struct CancellationHandle { /* private fields */ }

Read-only view of cancellation state, cheaply cloneable.

The loop and tool executors receive a CancellationHandle and use it to create TurnCancellation checkpoints or poll for interrupts directly.

Obtain one from CancellationController::handle.

Implementations

impl CancellationHandle

pub fn generation(&self) -> u64

Returns the current generation counter.

pub fn checkpoint(&self) -> TurnCancellation

Creates a TurnCancellation checkpoint capturing the current generation.

pub fn is_cancelled_since(&self, generation: u64) -> bool

Returns true if the generation has changed since generation.

Arguments

• generation - The generation value to compare against, typically obtained from a prior call to generation.

pub async fn cancelled_since(&self, generation: u64)

Waits asynchronously until the generation changes from generation.

Polls the generation counter every 10 ms. Prefer using TurnCancellation::cancelled instead, which captures the generation automatically.

Arguments

• generation - The generation value to wait for a change from.

Trait Implementations

impl Clone for CancellationHandle

fn clone(&self) -> CancellationHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancellationHandle

fn default() -> CancellationHandle

Returns the “default value” for a type.