Struct InterruptToken 

pub struct InterruptToken { /* private fields */ }

Async-safe cancellation token shared across all components of a run.

Usage

let token = InterruptToken::new();
let child = token.clone();

// In the agent thread
if child.is_requested() {
    // bail out
}

// In the UI thread on ESC
token.request();

Implementations

impl InterruptToken

pub fn new() -> Self

Create a new un-triggered token.

pub fn request(&self)

Signal that the user wants to cancel the current operation.

This is cheap and idempotent — calling it multiple times is fine.

pub fn force_interrupt(&self)

Force-interrupt the current operation.

In the Rust implementation this is identical to request() since we rely on cooperative cancellation via the CancellationToken rather than injecting async exceptions into threads (which is a CPython-specific trick).

pub fn request_background(&self)

Request that the current operation be moved to the background.

This cancels the CancellationToken to immediately interrupt any in-flight async operation (LLM streaming, tool execution), but does NOT set the hard interrupt flag. The react loop distinguishes background from hard interrupt by checking is_background_requested().

pub fn is_background_requested(&self) -> bool

Check whether backgrounding has been requested.

pub fn is_requested(&self) -> bool

Check whether cancellation has been requested.

This is a cheap atomic load suitable for hot polling loops.

pub fn throw_if_requested(&self) -> Result<(), InterruptedError>

Return an error if cancellation was requested.

pub async fn cancelled(&self)

Wait until cancellation is requested.

This is the primary async integration point — select! against this alongside your actual work future.

pub fn cancellation_token(&self) -> &CancellationToken

Get the underlying tokio_util::sync::CancellationToken.

Useful when you need to pass a token to lower-level async code or create child tokens.

pub fn child_token(&self) -> CancellationToken

Create a child token that is cancelled when the parent is cancelled.

pub fn reset(&self)

Clear the cancellation signal (use with care — mainly for token reuse across multiple agent runs).

pub fn should_interrupt(&self) -> bool

Alias for is_requested() — TaskMonitor compatibility.

pub fn request_interrupt(&self)

Alias for request() — TaskMonitor compatibility.

Trait Implementations

impl Clone for InterruptToken

fn clone(&self) -> InterruptToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InterruptToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InterruptToken

fn default() -> Self

Returns the “default value” for a type.