Struct EditTool 

pub struct EditTool { /* private fields */ }

Agent tool that applies unique non-overlapping text replacements.

Implementations

impl EditTool

pub fn new(cwd: impl Into<PathBuf>) -> Self

Creates an edit tool rooted at cwd.

pub fn with_options(options: EditToolOptions) -> Self

Creates an edit tool from explicit options.

pub fn parameters_schema() -> Value

Returns the JSON Schema for edit arguments (normalized TypeBox shape).

pub fn prepare_edit_arguments(raw: &Map<String, Value>) -> Map<String, Value>

Compatibility shim for legacy top-level oldText/newText and stringified edits.

pub fn parse_input( args: &Map<String, Value>, ) -> Result<EditToolInput, ToolError>

Validates prepared arguments and requires a non-empty edits list.

Errors

Returns ToolError when required fields are missing, mistyped, or edits is empty.

pub fn success_text(path: &str, edit_count: usize) -> String

Formats the success text using the caller’s path string.

Trait Implementations

impl AgentTool for EditTool

fn name(&self) -> &'static str

Unique tool name.

fn label(&self) -> &'static str

Human-readable label for UI display.

fn description(&self) -> &str

Human-readable tool description.

fn parameters(&self) -> &Value

JSON Schema for tool arguments.

fn prepare_arguments( &self, raw: &Map<String, Value>, ) -> Result<Map<String, Value>, ToolError>

Optional compatibility shim for raw tool-call arguments before validation.

fn validate_arguments( &self, args: &Map<String, Value>, ) -> Result<Map<String, Value>, ToolError>

Validates prepared arguments for this tool.

fn execute( &self, _tool_call_id: &str, args: Map<String, Value>, cancel: CancellationToken, _updates: ToolUpdates, ) -> BoxFuture<'static, Result<AgentToolResult, ToolError>>

Executes the tool call.

fn execution_mode(&self) -> Option<ToolExecutionMode>

Optional per-tool execution mode override.

fn prepare_and_validate_arguments( &self, raw: Map<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<Map<String, Value>, ToolError>> + Send + '_>>

Prepares and validates raw arguments before lifecycle hooks and execution.

impl Clone for EditTool

fn clone(&self) -> EditTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditTool

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

Formats the value using the given formatter.