Struct ToolCallUpdate 

#[non_exhaustive]
pub struct ToolCallUpdate {
    pub tool_call_id: ToolCallId,
    pub title: MaybeUndefined<String>,
    pub kind: MaybeUndefined<ToolKind>,
    pub status: MaybeUndefined<ToolCallStatus>,
    pub content: MaybeUndefined<Vec<ToolCallContent>>,
    pub locations: MaybeUndefined<Vec<ToolCallLocation>>,
    pub raw_input: MaybeUndefined<Value>,
    pub raw_output: MaybeUndefined<Value>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Represents an upsert for a tool call that the language model has requested.

Tool calls are actions that the agent executes on behalf of the language model, such as reading files, executing code, or fetching data from external sources.

Only ToolCallUpdate::tool_call_id is required. Other fields have patch semantics: omitted fields leave the existing tool call value unchanged, null clears or unsets the value, and concrete values replace the previous value. For collection fields, concrete arrays replace the previous collection, and both null and [] clear the collection. When a client receives a tool call ID it has not seen before, omitted fields use client defaults.

See protocol docs: Tool Calls

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.

tool_call_id: ToolCallId

Unique identifier for this tool call within the session.

title: MaybeUndefined<String>

Human-readable title describing what the tool is doing.

kind: MaybeUndefined<ToolKind>

The category of tool being invoked. Helps clients choose appropriate icons and UI treatment.

status: MaybeUndefined<ToolCallStatus>

Current execution status of the tool call.

content: MaybeUndefined<Vec<ToolCallContent>>

Content produced by the tool call.

locations: MaybeUndefined<Vec<ToolCallLocation>>

File locations affected by this tool call. Enables “follow-along” features in clients.

raw_input: MaybeUndefined<Value>

Raw input parameters sent to the tool.

raw_output: MaybeUndefined<Value>

Raw output returned by the tool.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl ToolCallUpdate

pub fn new(tool_call_id: impl Into<ToolCallId>) -> ToolCallUpdate

Builds ToolCallUpdate with the required fields set; optional fields start unset or empty.

pub fn title(self, title: impl IntoMaybeUndefined<String>) -> ToolCallUpdate

Human-readable title describing what the tool is doing.

pub fn kind(self, kind: impl IntoMaybeUndefined<ToolKind>) -> ToolCallUpdate

The category of tool being invoked. Helps clients choose appropriate icons and UI treatment.

pub fn status( self, status: impl IntoMaybeUndefined<ToolCallStatus>, ) -> ToolCallUpdate

Current execution status of the tool call.

pub fn content( self, content: impl IntoMaybeUndefined<Vec<ToolCallContent>>, ) -> ToolCallUpdate

Content produced by the tool call.

pub fn locations( self, locations: impl IntoMaybeUndefined<Vec<ToolCallLocation>>, ) -> ToolCallUpdate

File locations affected by this tool call. Enables “follow-along” features in clients.

pub fn raw_input( self, raw_input: impl IntoMaybeUndefined<Value>, ) -> ToolCallUpdate

Raw input parameters sent to the tool.

pub fn raw_output( self, raw_output: impl IntoMaybeUndefined<Value>, ) -> ToolCallUpdate

Raw output returned by the tool.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> ToolCallUpdate

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

pub fn apply_update(&mut self, update: ToolCallUpdate)

Applies a later tool-call patch to this stored tool-call state.

Fields set to null are preserved as null so callers can decide how to render an explicitly cleared value.

Trait Implementations

impl Clone for ToolCallUpdate

fn clone(&self) -> ToolCallUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCallUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolCallUpdate

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolCallUpdate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for ToolCallUpdate

type Output = ToolCallUpdate

The corresponding v1 type.

fn into_v1( self, ) -> Result<<ToolCallUpdate as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonSchema for ToolCallUpdate

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 ToolCallUpdate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolCallUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolCallUpdate