Struct Tool 

pub struct Tool { /* private fields */ }

A tool the program runs (R8.4.1): a name, a description, an input schema sent to the model as given, whether it asks before every call, how long harness waits for it, and an async handler.

Implementations

impl Tool

pub fn new<T, E, F, Fut>( name: impl Into<String>, description: impl Into<String>, schema: Value, handler: F, ) -> Self

where T: DeserializeOwned + Send + 'static, E: Display + 'static, F: Fn(T, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<ToolOutput, E>> + Send + 'static,

A tool whose calls run handler with the model’s arguments as a T.

Before the handler runs, the arguments are checked against the schema’s top-level required, each property’s type and additionalProperties: false, then deserialized; a call that fails either, an Err, or a panic answers is_error with the reason.

pub fn ask(self, ask: bool) -> Self

Ask before every call (R3.5.1); default false.

pub fn timeout(self, timeout: Duration) -> Self

How long harness waits for a call before cancelling it; default 5 minutes, at most 24 hours. Sent in whole seconds, rounded up.

pub fn name(&self) -> &str

The tool’s name.

Trait Implementations

impl Clone for Tool

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 Tool

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

Formats the value using the given formatter.