Struct ToolCall 

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

Represents 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.

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: String

Human-readable title describing what the tool is doing.

kind: ToolKind

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

status: ToolCallStatus

Current execution status of the tool call.

content: Vec<ToolCallContent>

Content produced by the tool call.

locations: Vec<ToolCallLocation>

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

raw_input: Option<Value>

Raw input parameters sent to the tool.

raw_output: Option<Value>

Raw output returned by the tool.

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 ToolCall

pub fn new( tool_call_id: impl Into<ToolCallId>, title: impl Into<String>, ) -> Self

pub fn kind(self, kind: ToolKind) -> Self

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

pub fn status(self, status: ToolCallStatus) -> Self

Current execution status of the tool call.

pub fn content(self, content: Vec<ToolCallContent>) -> Self

Content produced by the tool call.

pub fn locations(self, locations: Vec<ToolCallLocation>) -> Self

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

pub fn raw_input(self, raw_input: impl IntoOption<Value>) -> Self

Raw input parameters sent to the tool.

pub fn raw_output(self, raw_output: impl IntoOption<Value>) -> Self

Raw output returned by the tool.

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

pub fn update(&mut self, fields: ToolCallUpdateFields)

Update an existing tool call with the values in the provided update fields. Fields with collections of values are overwritten, not extended.

Trait Implementations

impl Clone for ToolCall

fn clone(&self) -> ToolCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCall

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolCall

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 ToolCall

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 ToolCall

fn eq(&self, other: &ToolCall) -> 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 ToolCall

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 ToolCall