Struct ToolResult 

pub struct ToolResult {
    pub output: Value,
    pub success: bool,
    pub metadata: HashMap<String, Value>,
}

Structured result from tool execution.

Wraps the tool’s output value with optional metadata (result count, source, confidence, execution details, etc.). Backward-compatible: Value auto-converts to ToolResult::ok(value).

Example

use pe_tools::tool::ToolResult;
use serde_json::json;

let result = ToolResult::ok(json!({"answer": 42}))
    .with_metadata("source", json!("database"))
    .with_metadata("result_count", json!(1));
assert!(result.success);
assert_eq!(result.metadata["source"], "database");

Fields

output: Value

The tool’s output value.

success: bool

Whether the tool succeeded.

metadata: HashMap<String, Value>

Tool-specific metadata (result count, source, confidence, etc.).

Implementations

impl ToolResult

pub fn ok(output: Value) -> Self

Create a successful result.

pub fn error(msg: impl Into<String>) -> Self

Create an error result with a message.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Add metadata to this result.

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> ToolResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Value> for ToolResult

Backward compatibility: raw Value auto-converts to successful ToolResult.

fn from(v: Value) -> Self

Converts to this type from the input type.

impl Serialize for ToolResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.