Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A caller-owned cancellation signal for one request.

Cloning this token is cheap and preserves a single cancellation state. The token is passed into CPU-stage closures; those closures must checkpoint at every talker-frame boundary once model execution is connected.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates an active cancellation token.

pub fn cancel(&self)

Requests cooperative cancellation.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

pub fn checkpoint(&self) -> Result<(), EngineError>

Returns Cancelled when a stage must stop cooperatively.

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.