Skip to main content

DynamicTool

Struct DynamicTool 

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

A tool defined at runtime: a name, a schema and a callback. The callback is the handler (ToolFn); this struct is its definition plus the erased handler a registry stages until a bus takes it. The optional liveness probe supports registry retirement; inline execution does not consult it.

Implementations§

Source§

impl DynamicTool

Source

pub fn new<F>( name: impl Into<String>, description: impl Into<String>, parameters: Value, callback: F, ) -> DynamicTool
where F: Fn(Value) -> Pin<Box<dyn Future<Output = Result<ToolOutput, ToolExecutionError>> + Send>> + WasmCompatSend + WasmCompatSync + 'static,

Define a tool from a context-free callback over owned arguments.

Source

pub fn new_with_context<F>( name: impl Into<String>, description: impl Into<String>, parameters: Value, callback: F, ) -> DynamicTool
where F: ToolCallback + 'static,

Define a tool from a callback over the dispatch-scoped context.

Source

pub fn with_liveness<F>(self, is_live: F) -> DynamicTool
where F: Fn() -> bool + WasmCompatSend + WasmCompatSync + 'static,

Attach a liveness probe.

Source

pub fn name(&self) -> &str

The tool’s name.

Source

pub fn definition(&self) -> ToolDefinition

The tool’s definition.

Source

pub fn handler(&self) -> &ErasedHandler

The erased handler behind this definition.

Source

pub fn into_parts( self, ) -> (ToolDefinition, ErasedHandler, Option<Arc<dyn Fn() -> bool + Send + Sync>>)

Consumes the tool into its definition, handler, and optional liveness probe.

Source

pub fn is_live(&self) -> bool

Whether the tool’s owner still serves it (true without a probe).

Source

pub async fn execute( &self, arguments: Value, ) -> Result<ToolOutput, ToolExecutionError>

Run the tool inline with an empty context.

Source

pub async fn execute_with( &self, context: &mut ToolContext, arguments: Value, ) -> Result<ToolOutput, ToolExecutionError>

Run the tool inline with isolated inbound values. A completed call replaces only context’s result metadata, including when the tool returns an error. Dropping the execution future leaves the caller’s context unchanged; it does not publish partial mutations.

Trait Implementations§

Source§

impl Clone for DynamicTool

Source§

fn clone(&self) -> DynamicTool

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DynamicTool

Source§

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

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

impl From<Agent> for DynamicTool

Source§

fn from(agent: Agent) -> Self

Converts to this type from the input type.

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> Same for T

Source§

type Output = T

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

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

fn try_from(value: U) -> Result<T, !>

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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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