Skip to main content

ToolRegistry

Struct ToolRegistry 

Source
pub struct ToolRegistry { /* private fields */ }

Implementations§

Source§

impl ToolRegistry

Source

pub fn new() -> Self

Create an empty registry.

Source

pub fn register<T: RustTool + 'static>(&mut self, tool: T) -> &mut Self

Register a RustTool. Returns &mut Self for chaining.

The tool’s ToolDefinition (including JSON schema) is computed once here and cached for the lifetime of the registration.

If a tool with the same name was already registered, it is replaced.

§Panics

Panics if the tool’s JSON schema cannot be serialized. This indicates a bug in the tool’s Params type (e.g. a broken JsonSchema impl).

Source

pub fn with_tool<T: RustTool + 'static>(self, tool: T) -> Self

Register a RustTool, consuming and returning Self for owned chaining.

This is the owned counterpart of register, enabling patterns like:

use llm_tool::{RustTool, ToolContext, ToolError, ToolOutput, ToolRegistry};
use schemars::JsonSchema;
use serde::Deserialize;

#[derive(Deserialize, JsonSchema)]
struct NoParams {}

struct ToolA;
impl RustTool for ToolA {
    type Params = NoParams;
    const NAME: &'static str = "tool_a";
    const DESCRIPTION: &'static str = "Tool A";
    async fn call(&self, _: NoParams, _: &ToolContext) -> Result<ToolOutput, ToolError> {
        Ok("a".into())
    }
}

struct ToolB;
impl RustTool for ToolB {
    type Params = NoParams;
    const NAME: &'static str = "tool_b";
    const DESCRIPTION: &'static str = "Tool B";
    async fn call(&self, _: NoParams, _: &ToolContext) -> Result<ToolOutput, ToolError> {
        Ok("b".into())
    }
}

let registry = ToolRegistry::new().with_tool(ToolA).with_tool(ToolB);

assert_eq!(registry.definitions().len(), 2);
Source

pub fn definitions(&self) -> Vec<ToolDefinition>

Collect ToolDefinitions for all registered tools.

Returns clones of the cached definitions computed at registration time.

Source

pub async fn dispatch( &self, name: &str, args: Value, ctx: &ToolContext, ) -> Result<ToolOutput, ToolError>

Dispatch a tool call by name with raw JSON arguments and a context.

§Errors

Returns Err if the tool name is unknown or the handler returns an error.

Source

pub fn len(&self) -> usize

Number of registered tools.

Source

pub fn is_empty(&self) -> bool

Whether the registry has no registered tools.

Source

pub fn iter(&self) -> impl Iterator<Item = (&'static str, ToolDefinition)> + '_

Iterate over (name, definition) pairs for every registered tool.

Returns clones of the cached definitions computed at registration time.

Trait Implementations§

Source§

impl Debug for ToolRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ToolRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> IntoIterator for &'a ToolRegistry

Iterate over (name, definition) pairs for every registered tool.

Yields (&'static str, ToolDefinition) for each tool in the registry.

Source§

type Item = (&'static str, ToolDefinition)

The type of the elements being iterated over.
Source§

type IntoIter = Box<dyn Iterator<Item = (&'static str, ToolDefinition)> + 'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more