Enum ToolEvent 

pub enum ToolEvent {
    Call {
        request: ToolCallRequest,
    },
    CallUpdate {
        tool_call_id: String,
        chunk: String,
    },
    ExecutionStarted {
        tool_id: String,
        tool_name: String,
    },
    Progress {
        request: ToolCallRequest,
        progress: f64,
        total: Option<f64>,
        message: Option<String>,
    },
    SubAgentProgress {
        request: ToolCallRequest,
        payload: Box<SubAgentProgressPayload>,
    },
    DisplayUpdate {
        request: ToolCallRequest,
        meta: ToolResultMeta,
    },
    TaskCreated {
        request: ToolCallRequest,
        task_id: String,
        status_message: Option<String>,
    },
    TaskStatus {
        request: ToolCallRequest,
        task_id: String,
        status: String,
        status_message: Option<String>,
    },
    TaskCompleted {
        request: ToolCallRequest,
        task_id: String,
        result: ToolCallResult,
        result_meta: Option<ToolResultMeta>,
    },
    TaskFailed {
        request: ToolCallRequest,
        task_id: String,
        error: ToolCallError,
    },
    TaskCancelled {
        request: ToolCallRequest,
        task_id: String,
    },
    Result {
        result: ToolCallResult,
        result_meta: Option<ToolResultMeta>,
    },
    Error {
        error: ToolCallError,
    },
    DefinitionsUpdated {
        tools: Vec<ToolDefinition>,
    },
}

Tool call lifecycle events.

Variants

Call

The LLM requested a tool call; arguments may still be streaming.

Fields

request: ToolCallRequest

CallUpdate

A chunk of streamed tool call arguments.

Fields

tool_call_id: String

chunk: String

ExecutionStarted

The tool began executing.

Fields

tool_id: String

tool_name: String

Progress

Progress reported by an executing tool.

Fields

request: ToolCallRequest

progress: f64

total: Option<f64>

message: Option<String>

SubAgentProgress

Progress from a sub-agent spawned by this tool call, carrying the child’s own event.

Fields

request: ToolCallRequest

payload: Box<SubAgentProgressPayload>

DisplayUpdate

An executing tool refreshed how it should be displayed.

Fields

request: ToolCallRequest

meta: ToolResultMeta

TaskCreated

A background task was created by a tool call response.

Fields

request: ToolCallRequest

task_id: String

status_message: Option<String>

TaskStatus

The background task reported a new status.

Fields

request: ToolCallRequest

task_id: String

status: String

status_message: Option<String>

TaskCompleted

The background task completed successfully.

Fields

request: ToolCallRequest

task_id: String

result: ToolCallResult

result_meta: Option<ToolResultMeta>

TaskFailed

The background task failed.

Fields

request: ToolCallRequest

task_id: String

error: ToolCallError

TaskCancelled

The background task was cancelled.

Fields

request: ToolCallRequest

task_id: String

Result

The tool completed successfully.

Fields

result: ToolCallResult

result_meta: Option<ToolResultMeta>

Error

The tool failed.

Fields

error: ToolCallError

DefinitionsUpdated

The set of available tool definitions changed.

Fields

tools: Vec<ToolDefinition>

Implementations

impl ToolEvent

pub fn task_context_message(&self) -> Option<ChatMessage>

The context message describing a terminal background-task event, or None for every other event.

Trait Implementations

impl Clone for ToolEvent

fn clone(&self) -> ToolEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TaskOutcome> for ToolEvent

fn from(outcome: TaskOutcome) -> Self

Converts to this type from the input type.

impl JsonSchema for ToolEvent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ToolEvent

fn eq(&self, other: &ToolEvent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolEvent