Struct ToolCallUpdate 

#[non_exhaustive]
pub struct ToolCallUpdate {
    pub tool_call_id: ToolCallId,
    pub fields: ToolCallUpdateFields,
    pub meta: Option<Meta>,
}

An update to an existing tool call.

Used to report progress and results as tools execute. All fields except the tool call ID are optional - only changed fields need to be included.

See protocol docs: Updating

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

The ID of the tool call being updated.

fields: ToolCallUpdateFields

Fields being updated.

meta: Option<Meta>

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>, fields: ToolCallUpdateFields, ) -> Self

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

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

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolCall> for ToolCallUpdate

fn from(value: ToolCall) -> Self

Converts to this type from the input 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ToolCallUpdate> for ToolCall

If a given tool call doesn’t exist yet, allows for attempting to construct one from a tool call update if possible.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(update: ToolCallUpdate) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ToolCallUpdate