Struct WriteFileTool 

pub struct WriteFileTool { /* private fields */ }

Implementations

impl WriteFileTool

pub const NAME: &'static str = "write_file"

Tool name used for registration and function definition.

pub fn new(workspace: PathBuf) -> Self

Create a new WriteFileTool with the default workspace directory. You can add workspace directories for each call by including workspace or workspaces in the tool call’s context meta extra.

pub fn with_workspaces<I>(workspaces: I) -> Self

where I: IntoIterator<Item = PathBuf>,

Create a new WriteFileTool with the default workspace directories. Context meta workspaces take precedence over these defaults at call time.

pub fn with_description(self, description: String) -> Self

Trait Implementations

impl Clone for WriteFileTool

fn clone(&self) -> WriteFileTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Tool<BaseCtx> for WriteFileTool

type Args = WriteFileArgs

The arguments type of the tool.

type Output = WriteFileOutput

The output type of the tool.

fn name(&self) -> String

Returns the unique tool name.

fn description(&self) -> String

Returns a concise description of the tool’s capability.

fn definition(&self) -> FunctionDefinition

Returns the function definition, including the JSON parameter schema.

async fn call( &self, ctx: BaseCtx, args: Self::Args, _resources: Vec<Resource>, ) -> Result<ToolOutput<Self::Output>, BoxError>

Executes the tool with typed arguments and selected resources.

fn supported_resource_tags(&self) -> Vec<String>

Returns resource tags this tool can consume.

fn select_resources(&self, resources: &mut Vec<Resource>) -> Vec<Resource>

Removes and returns resources matching this tool’s supported tags.

fn init( &self, _ctx: C, ) -> impl Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send

Initializes the tool with the given context.

fn call_raw( &self, ctx: C, args: Value, resources: Vec<Resource>, ) -> impl Future<Output = Result<ToolOutput<Value>, Box<dyn Error + Send + Sync>>> + Send

Executes the tool from raw JSON arguments and returns JSON output.