Struct EditResult 

#[non_exhaustive]
pub struct EditResult {

    pub path: String,
    pub original_content: String,
    pub new_content: String,
    pub diff: String,
    pub applied: bool,
    pub changed: bool,
    pub action: &'static str,
    pub dest_path: Option<String>,
    pub match_count: usize,
    pub removed: usize,
    pub match_mode: Option<MatchMode>,
    pub match_score: Option<f64>,
    pub matched_text: Option<String>,
    pub backup_session: Option<String>,
}

The result of an editing operation.

Marked non_exhaustive so new honesty fields (for example matched_text) can land in minor releases without breaking external struct literals.

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

Path to the affected file (as provided by the caller).

original_content: String

The original file content before the edit.

new_content: String

The new content after the edit.

diff: String

A unified diff between original and new content.

applied: bool

Whether the file was actually written to disk.

changed: bool

Whether the content changed.

action: &'static str

Action/kind of the edit (e.g. “append”, “create”, “replace”, “rename”, “doc.set”). Helps agent hosts distinguish cross-file or op type without parsing path.

dest_path: Option<String>

For cross-file operations (e.g. file_rename, md_move_section with to), the destination path if different from path.

match_count: usize

Number of times the search pattern matched in the original content.

Only meaningful for replace operations; defaults to 0 for other operation types (doc, md, file, patch, tidy).

removed: usize

Number of items removed by the operation (keys, array elements, etc.).

Meaningful for doc.delete and doc.delete_where (including idempotent no-ops where removed == 0 and changed == false). Defaults to 0 for other operation types. Mirrors MCP/tx JSON mutation summaries so embedders can report delete outcomes without re-reading the file or parsing diffs (#1459 / #1439).

match_mode: Option<MatchMode>

Match strategy used for replace ops (None for non-replace ops). See #1662.

match_score: Option<f64>

Similarity score when MatchMode::Fuzzy was used; otherwise None.

matched_text: Option<String>

Text actually matched for fuzzy/anchored replace (may differ from old).

Agents must not treat match_mode == Fuzzy + high match_score alone as “correct target”: compare this field to the requested pattern and prefer ast_rename for identifier renames (#1736). For over-wide fuzzy spans, with for_agent, auto-refuse via ReplaceOptions::refuse_suspicious_fuzzy; custom options still call fuzzy_span_suspicious before trust (#1981 / #2005).

backup_session: Option<String>

Backup session timestamp created for this Apply (if any).

Set when a write produced a backup session (see BackupSession::finalize). None for Preview/Check, no-ops, or when nothing was backed up. Use with crate::backup::restore_path_from_session for surgical undo (#1686).

Trait Implementations

impl Clone for EditResult

fn clone(&self) -> EditResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditResult

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

Formats the value using the given formatter.