Struct StructuredFunctionTool 

pub struct StructuredFunctionTool { /* private fields */ }

Like FunctionTool, but returns structured ToolResult with metadata.

Use this when your tool needs to report result count, source, confidence, etc.

Implementations

impl StructuredFunctionTool

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, func: impl Fn(Value) -> Pin<Box<dyn Future<Output = Result<ToolResult, PeError>> + Send>> + Send + Sync + 'static, ) -> Self

Create a new structured function tool.

Trait Implementations

impl Debug for StructuredFunctionTool

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

Formats the value using the given formatter.

impl Tool for StructuredFunctionTool

fn name(&self) -> &str

Tool name — must be unique within a super::ToolRegistry. Sent to the LLM in the tools list.

fn description(&self) -> &str

Human-readable description of what this tool does. The LLM reads this to decide when to call the tool.

fn schema(&self) -> ToolSchema

JSON Schema for this tool’s input parameters. InjectedState and InjectedStore parameters MUST be excluded.

fn execute(&self, input: Value) -> ToolFuture

Execute the tool with the given input. Called by super::ToolNode.

fn execute_structured(&self, input: Value) -> ToolResultFuture

Execute with structured result metadata.