Struct WriteTool 

pub struct WriteTool { /* private fields */ }

Write Tool for writing files

Supports:

• Creating new files
• Overwriting existing files (with read validation)
• Creating parent directories

Requirements: 4.6

Implementations

impl WriteTool

pub fn new(read_history: SharedFileReadHistory) -> Self

Create a new WriteTool with shared history

pub fn with_require_read_before_overwrite(self, require: bool) -> Self

Set whether to require read before overwrite

pub fn read_history(&self) -> &SharedFileReadHistory

Get the shared read history

impl WriteTool

pub async fn write_file( &self, path: &Path, content: &str, context: &ToolContext, ) -> Result<ToolResult, ToolError>

Write content to a file

If the file exists and require_read_before_overwrite is true, the file must have been read first.

Requirements: 4.6

pub fn can_write(&self, path: &Path, context: &ToolContext) -> bool

Check if a file can be written (exists and has been read, or doesn’t exist)

Trait Implementations

impl Debug for WriteTool

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

Formats the value using the given formatter.

impl Tool for WriteTool

fn name(&self) -> &str

Returns the unique name of the tool

fn description(&self) -> &str

Returns a human-readable description of the tool

fn input_schema(&self) -> Value

Returns the JSON Schema for the tool’s input parameters

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

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

fn options(&self) -> ToolOptions

Get the tool’s configuration options

fn dynamic_description(&self) -> Option<String>

Returns a dynamically generated description of the tool

fn get_definition(&self) -> ToolDefinition

Get the tool definition for LLM consumption