Struct ToolCallLocation 

#[non_exhaustive]
pub struct ToolCallLocation {
    pub path: PathBuf,
    pub line: Option<u32>,
    pub meta: Option<Map<String, Value>>,
}

A file location being accessed or modified by a tool.

Enables clients to implement “follow-along” features that track which files the agent is working with in real-time.

See protocol docs: Following the Agent

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.

path: PathBuf

The file path being accessed or modified.

line: Option<u32>

Optional line number within the file.

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 ToolCallLocation

pub fn new(path: impl Into<PathBuf>) -> ToolCallLocation

pub fn line(self, line: impl IntoOption<u32>) -> ToolCallLocation

Optional line number within the file.

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

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 ToolCallLocation

fn clone(&self) -> ToolCallLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCallLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolCallLocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ToolCallLocation

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 ToolCallLocation

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

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 Eq for ToolCallLocation

impl StructuralPartialEq for ToolCallLocation