Struct BackgroundToolTracker 

pub struct BackgroundToolTracker { /* private fields */ }

Tracks in-flight background tool executions for cancellation.

Uses [DashMap] internally so that spawned tasks can remove themselves upon completion while the control lane concurrently spawns or cancels other tasks.

Implementations

impl BackgroundToolTracker

pub fn new() -> Self

Create a new, empty tracker.

pub fn spawn( &self, call_id: String, task: JoinHandle<()>, cancel: CancellationToken, )

Register a spawned background task.

The call_id is the unique identifier for the function call (usually from [FunctionCall::id]). The caller provides both a [JoinHandle] (for aborting) and a [CancellationToken] (for cooperative cancellation).

pub fn cancel(&self, call_ids: &[String])

Cancel specific tool calls by their IDs.

For each matching ID the cancellation token is triggered and the task handle is aborted, providing belt-and-suspenders cleanup. Non-existent IDs are silently ignored.

pub fn cancel_all(&self)

Cancel all in-flight background tasks.

Useful during session shutdown to ensure no orphaned tasks remain.

pub fn active_ids(&self) -> Vec<String>

Get IDs of active background tool calls.

pub fn remove(&self, call_id: &str)

Remove a completed task (called when background task finishes).

This is typically invoked by the spawned task itself to clean up the tracker entry once execution is done.

pub fn active_count(&self) -> usize

Number of active background tasks.

Trait Implementations

impl Default for BackgroundToolTracker

fn default() -> Self

Returns the “default value” for a type.