Skip to main content

ToolRegistry

Struct ToolRegistry 

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

Registry of client-side tools available to the HTTP agent provider.

Converts registered tools to the OpenAI tools array format and routes tool call execution to the correct tool implementation.

§Examples

use ironflow_core::providers::http::tools::ToolRegistry;

let registry = ToolRegistry::new();
// registry.register(my_tool);
let tools_json = registry.to_openai_tools();

Implementations§

Source§

impl ToolRegistry

Source

pub fn new() -> Self

Create an empty registry.

Source

pub fn register(self, tool: impl Tool + 'static) -> Self

Register a tool. Panics if a tool with the same name is already registered.

§Panics

Panics if a tool with the same name already exists in the registry.

Source

pub fn len(&self) -> usize

Returns the number of registered tools.

Source

pub fn is_empty(&self) -> bool

Returns true if no tools are registered.

Source

pub fn to_openai_tools(&self) -> Vec<Value>

Convert all registered tools to the OpenAI tools array format.

Each tool is represented as:

{
  "type": "function",
  "function": {
    "name": "tool_name",
    "description": "tool description",
    "parameters": { ... json schema ... }
  }
}
Source

pub async fn execute( &self, name: &str, input: Value, ) -> Option<Result<ToolOutput, ToolError>>

Execute a tool by name with the given input.

Returns None if no tool with that name is registered.

Source

pub fn has_tool(&self, name: &str) -> bool

Check if a tool with the given name is registered.

Trait Implementations§

Source§

impl Default for ToolRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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