Struct Diff 

#[non_exhaustive]
pub struct Diff {
    pub changes: Vec<DiffChange>,
    pub patch: Option<DiffPatch>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

File changes produced by a tool call.

changes identifies affected absolute paths and operations. patch optionally carries renderable patch text for clients that can show it. Agents SHOULD provide patch whenever feasible. Clients MUST handle diffs where patch is omitted or null.

See protocol docs: Content

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.

changes: Vec<DiffChange>

Structured file changes described by this diff.

Clients can use this field without parsing patch text to determine affected paths.

patch: Option<DiffPatch>

Renderable patch text.

Agents SHOULD provide patch text whenever feasible. Omitted or null means no renderable patch text was provided.

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 Diff

pub fn new(changes: Vec<DiffChange>) -> Diff

Builds Diff with structured file changes.

pub fn patch(diff: impl Into<String>, changes: Vec<DiffChange>) -> Diff

Builds Diff with git patch text and structured file changes.

pub fn with_patch(self, patch: impl IntoOption<DiffPatch>) -> Diff

Sets renderable patch text.

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

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 Diff

fn clone(&self) -> Diff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diff

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Diff

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Diff

impl From<Diff> for ToolCallContent

fn from(diff: Diff) -> ToolCallContent

Converts to this type from the input type.

impl IntoV1 for Diff

type Output = Diff

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for Diff

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 Diff

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

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 Diff