Skip to main content

SyncFunctionTool

Struct SyncFunctionTool 

Source
pub struct SyncFunctionTool<F, Deps = ()> { /* private fields */ }
Expand description

Wrapper for sync function tools.

For tools that don’t need async, this provides a simpler API.

Implementations§

Source§

impl<F, Deps> SyncFunctionTool<F, Deps>
where F: Fn(&RunContext<Deps>, Value) -> ToolResult + Send + Sync,

Source

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: impl Into<JsonValue>, function: F, ) -> Self

Create a new sync function tool.

Source

pub fn with_max_retries(self, retries: u32) -> Self

Set maximum retries.

Trait Implementations§

Source§

impl<F, Deps> Debug for SyncFunctionTool<F, Deps>

Source§

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

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

impl<F, Deps> Tool<Deps> for SyncFunctionTool<F, Deps>
where F: Fn(&RunContext<Deps>, Value) -> ToolResult + Send + Sync, Deps: Send + Sync,

Source§

fn definition(&self) -> ToolDefinition

Get the tool’s definition. Read more
Source§

fn call<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 RunContext<Deps>, args: JsonValue, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the tool with given arguments. Read more
Source§

fn max_retries(&self) -> Option<u32>

Maximum retries for this tool. Read more
Source§

fn prepare<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 RunContext<Deps>, def: ToolDefinition, ) -> Pin<Box<dyn Future<Output = Option<ToolDefinition>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Prepare the tool definition at runtime. Read more
Source§

fn name(&self) -> String

Get the tool name.
Source§

fn description(&self) -> String

Get the tool description.

Auto Trait Implementations§

§

impl<F, Deps> Freeze for SyncFunctionTool<F, Deps>
where F: Freeze,

§

impl<F, Deps> RefUnwindSafe for SyncFunctionTool<F, Deps>
where F: RefUnwindSafe,

§

impl<F, Deps> Send for SyncFunctionTool<F, Deps>
where F: Send,

§

impl<F, Deps> Sync for SyncFunctionTool<F, Deps>
where F: Sync,

§

impl<F, Deps> Unpin for SyncFunctionTool<F, Deps>
where F: Unpin,

§

impl<F, Deps> UnwindSafe for SyncFunctionTool<F, Deps>
where F: UnwindSafe,

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, 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.