pub struct EditTool { /* private fields */ }Expand description
Edit Tool for modifying files
Supports:
- Smart string matching with quote normalization
- Batch edits with atomic rollback
- External modification detection
- Match uniqueness validation
Requirements: 4.7, 4.8, 4.9, 4.10
Implementations§
Source§impl EditTool
impl EditTool
Sourcepub fn new(read_history: SharedFileReadHistory) -> Self
pub fn new(read_history: SharedFileReadHistory) -> Self
Create a new EditTool with shared history
Sourcepub fn with_require_read_before_edit(self, require: bool) -> Self
pub fn with_require_read_before_edit(self, require: bool) -> Self
Set whether to require read before edit
Sourcepub fn with_smart_quote_matching(self, enabled: bool) -> Self
pub fn with_smart_quote_matching(self, enabled: bool) -> Self
Set whether to enable smart quote matching
Sourcepub fn read_history(&self) -> &SharedFileReadHistory
pub fn read_history(&self) -> &SharedFileReadHistory
Get the shared read history
Source§impl EditTool
impl EditTool
Sourcepub fn normalize_quotes(s: &str) -> String
pub fn normalize_quotes(s: &str) -> String
Normalize quotes in a string for matching
Converts various quote styles to standard ASCII quotes:
- Smart quotes (“ “ ’ ’) -> ASCII quotes (“ ’)
- Curly quotes -> straight quotes
Requirements: 4.7
Sourcepub fn find_matches(&self, content: &str, search: &str) -> MatchResult
pub fn find_matches(&self, content: &str, search: &str) -> MatchResult
Find all matches of a string in content
If smart_quote_matching is enabled, normalizes quotes before matching.
Requirements: 4.7
Sourcepub fn is_unique_match(&self, content: &str, search: &str) -> bool
pub fn is_unique_match(&self, content: &str, search: &str) -> bool
Check if a match is unique (exactly one occurrence)
Source§impl EditTool
impl EditTool
Sourcepub async fn edit_file(
&self,
path: &Path,
old_str: &str,
new_str: &str,
context: &ToolContext,
) -> Result<ToolResult, ToolError>
pub async fn edit_file( &self, path: &Path, old_str: &str, new_str: &str, context: &ToolContext, ) -> Result<ToolResult, ToolError>
Apply a single edit to a file
Requirements: 4.7, 4.9, 4.10
Source§impl EditTool
impl EditTool
Sourcepub async fn batch_edit(
&self,
path: &Path,
edits: &[Edit],
context: &ToolContext,
) -> Result<ToolResult, ToolError>
pub async fn batch_edit( &self, path: &Path, edits: &[Edit], context: &ToolContext, ) -> Result<ToolResult, ToolError>
Apply multiple edits to a file atomically
All edits are validated before any are applied. If any edit fails validation, no changes are made.
Requirements: 4.8
Trait Implementations§
Source§impl Tool for EditTool
impl Tool for EditTool
Source§fn description(&self) -> &str
fn description(&self) -> &str
Returns a human-readable description of the tool Read more
Source§fn input_schema(&self) -> Value
fn input_schema(&self) -> Value
Returns the JSON Schema for the tool’s input parameters Read more
Source§fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
params: Value,
context: &'life1 ToolContext,
) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
params: Value,
context: &'life1 ToolContext,
) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Execute the tool with the given parameters and context Read more
Source§fn check_permissions<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
params: &'life1 Value,
context: &'life2 ToolContext,
) -> Pin<Box<dyn Future<Output = PermissionCheckResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn check_permissions<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
params: &'life1 Value,
context: &'life2 ToolContext,
) -> Pin<Box<dyn Future<Output = PermissionCheckResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Check permissions before executing the tool Read more
Source§fn options(&self) -> ToolOptions
fn options(&self) -> ToolOptions
Get the tool’s configuration options Read more
Source§fn dynamic_description(&self) -> Option<String>
fn dynamic_description(&self) -> Option<String>
Returns a dynamically generated description of the tool Read more
Source§fn get_definition(&self) -> ToolDefinition
fn get_definition(&self) -> ToolDefinition
Get the tool definition for LLM consumption Read more
Auto Trait Implementations§
impl Freeze for EditTool
impl RefUnwindSafe for EditTool
impl Send for EditTool
impl Sync for EditTool
impl Unpin for EditTool
impl UnsafeUnpin for EditTool
impl UnwindSafe for EditTool
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestCreates a shared type from an unshared type.
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.