Struct ToolDefinition 

pub struct ToolDefinition {
    pub handler: Arc<dyn ToolHandler>,
    pub parallelizable: bool,
}

Configuration for a tool provided by the host.

Fields

handler: Arc<dyn ToolHandler>

The tool handler. Uses Arc to allow cloning into spawned tasks for parallelizable tools.

parallelizable: bool

Whether this tool is safe for parallel (deferred) execution. Default: false (volatile/sequential).

Implementations

impl ToolDefinition

pub fn new(handler: impl ToolHandler + 'static) -> Self

Create a volatile (sequential) tool config.

pub fn parallel(handler: impl ToolHandler + 'static) -> Self

Create a parallelizable tool config.

pub fn from_fn<F, Fut>(f: F) -> Self

where F: Fn(HashMap<String, Value>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ToolError>> + Send + 'static,

Create a volatile tool from an async closure.

Example

ToolDefinition::from_fn(|kwargs| async move {
    let query = kwargs.require_str("query")?.to_string();
    Ok(Value::String(format!("found: {query}")))
})

pub fn from_fn_parallel<F, Fut>(f: F) -> Self

where F: Fn(HashMap<String, Value>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ToolError>> + Send + 'static,

Create a parallelizable tool from an async closure.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.