Struct CommandTool 

pub struct CommandTool { /* private fields */ }

Implementations

impl CommandTool

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

pub fn restrict_to( self, commands: impl IntoIterator<Item = impl Into<String>>, ) -> Self

pub fn max_output(self, bytes: usize) -> Self

pub fn named(self, name: impl Into<String>) -> Self

Trait Implementations

impl Clone for CommandTool

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandTool

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

Formats the value using the given formatter.

impl Tool for CommandTool

type Arguments = CommandArgs

Tool arguments type. Must implement schemars::JsonSchema and serde::de::DeserializeOwned. Its rustdoc becomes the default tool description.

type Res = ToolResult

Raw return type from the tool implementation.

fn name(&self) -> Cow<'static, str>

Tool name. Must be unique.

async fn call( &self, arguments: Self::Arguments, _cx: ToolContext, ) -> Result<Self::Res>

Executes the tool with the provided arguments.

fn description(&self) -> Cow<'static, str>

What the tool does, as shown to the model.