Skip to main content

ToolExecutor

Struct ToolExecutor 

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

Enhanced tool executor with built-in registry and fluent API

Implementations§

Source§

impl ToolExecutor

Source

pub fn new() -> Self

Create a new executor with default config

Source

pub fn builder() -> ExecutorBuilder

Create an executor builder for fluent API

Source

pub fn with_cache_enabled(self, enabled: bool) -> Self

Enable or disable tool call result caching

Source

pub fn with_cache_ttl(self, ttl: Duration) -> Self

Set cache TTL (time-to-live)

Source

pub fn with_cache_max_size(self, size: usize) -> Self

Set maximum cache size

Source

pub fn clear_cache(&self)

Clear the cache

Source

pub fn invalidate_cache_for_tool(&self, tool_name: &str)

Invalidate cache for a specific tool

Source

pub fn cache_stats(&self) -> CacheStats

Get cache statistics

Source

pub fn add_dyn_tool(&self, tool: Box<dyn DynTool>) -> &Self

Chain-friendly: add a dynamic tool (panics on error)

Source

pub fn try_add_dyn_tool(&self, tool: Box<dyn DynTool>) -> &Self

Chain-friendly: try to add a dynamic tool (ignores error)

Source

pub fn unregister(&self, name: &str) -> ToolResult<()>

Unregister a tool

Source

pub fn input_schema(&self, name: &str) -> Option<Value>

Get input schema for a tool

Source

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

Check if tool exists

Source

pub fn tool_names(&self) -> Vec<String>

List tool names

Source

pub async fn execute( &self, tool_name: &str, input: Value, ) -> ToolResult<ExecutionResult>

Execute a tool with detailed result and exponential backoff

Source

pub async fn execute_simple( &self, tool_name: &str, input: Value, ) -> ToolResult<Value>

Execute a tool and return only the result

Source

pub fn add_functions_from_dir_with_registry( &self, dir: impl AsRef<Path>, handlers: &HashMap<String, Arc<dyn Fn(Value) -> Pin<Box<dyn Future<Output = ToolResult<Value>> + Send>> + Send + Sync>>, strict: bool, ) -> ToolResult<Vec<String>>

Bulk load function specs from a directory of .json files and register them with handlers.

  • Each file should contain either of the following shapes:
    1. {“name”:…, “description”:…, “parameters”: {…}}
    2. {“type”:“function”, “function”: {“name”:…, “description”:…, “parameters”: {…}}}
  • handlers maps function name -> handler closure
  • strict: when true, missing handler for any spec will return error; when false, specs without handlers are skipped

Returns the list of function names successfully registered.

Source

pub async fn execute_tool_calls_parallel( &self, calls: &[ToolCallMessage], ) -> Vec<TextMessage>

Source

pub async fn execute_tool_calls_ordered( &self, calls: &[ToolCallMessage], ) -> Vec<TextMessage>

Execute LLM tool_calls in parallel with result ordering preserved

This method guarantees that results are returned in the same order as the input calls, which is important for maintaining conversation context in LLM interactions.

Behavior:

  • Parses each ToolCallMessage’s function.arguments (stringified JSON supported)
  • Runs all tools concurrently using this executor
  • Preserves the original order of tool calls in results
  • Captures errors per-call and encodes them as JSON
  • Preserves tool_call id by emitting TextMessage::tool_with_id when present

Returns:

  • Vec in the same order as input calls, ready for ChatCompletion
Source

pub fn export_tool_as_function(&self, name: &str) -> Option<Tools>

Export a single registered tool as Tools::Function (for LLM function calling)

Source

pub fn export_all_tools_as_functions(&self) -> Vec<Tools>

Export all registered tools as a VecTools::Function

Source

pub fn export_tools_filtered<F>(&self, filter: F) -> Vec<Tools>
where F: FnMut(&ToolMetadata) -> bool,

Export all registered tools with a metadata filter as Tools::Function

Source

pub fn config(&self) -> &ExecutionConfig

Get the config

Trait Implementations§

Source§

impl Clone for ToolExecutor

Source§

fn clone(&self) -> ToolExecutor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolExecutor

Source§

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

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

impl Default for ToolExecutor

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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