Struct ToolContext 

#[non_exhaustive]
pub struct ToolContext {
    pub state: State,
    pub call_id: Option<String>,
    pub cancel: CancellationToken,
}

The session a tool call runs in.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: State

The session state: read what the conversation captured, write what the tool learned.

call_id: Option<String>

The model’s id for this call, when it gave one.

cancel: CancellationToken

Cancelled when the call should stop: the user barged in, or the session is ending. A long tool can check it between steps; the runtime also drops the call’s future when it fires.

Implementations

impl ToolContext

pub fn new(state: State) -> ToolContext

A context over state, with no call id and a token nothing cancels.

pub fn detached() -> ToolContext

A context for a call made outside any session (a direct ToolFunction::call, a unit test): fresh, empty state.

pub fn with_call_id(self, id: impl Into<String>) -> ToolContext

With the model’s call id.

pub fn with_cancel(self, cancel: CancellationToken) -> ToolContext

With a cancellation token.

Trait Implementations

impl Clone for ToolContext

fn clone(&self) -> ToolContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolContext

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

Formats the value using the given formatter.