Struct ToolResult 

pub struct ToolResult {
    pub success: bool,
    pub output: String,
}

The result of a tool execution.

Fields

success: bool

Whether the execution was successful.

output: String

The output of the execution.

Implementations

impl ToolResult

pub fn success(output: impl Into<String>) -> Self

Creates a new successful ToolResult.

Examples found in repository

examples/custom_tool.rs (line 69)

    async fn execute(&self, args: Value) -> helios_engine::Result<ToolResult> {
        let location = args
            .get("location")
            .and_then(|v| v.as_str())
            .unwrap_or("Unknown");

        let unit = args
            .get("unit")
            .and_then(|v| v.as_str())
            .unwrap_or("fahrenheit");

        // In a real implementation, you would call a weather API here.
        let temp = if unit == "celsius" { "22" } else { "72" };
        let weather = format!(
            "The weather in {} is sunny with a temperature of {}°{}",
            location,
            temp,
            if unit == "celsius" { "C" } else { "F" }
        );

        Ok(ToolResult::success(weather))
    }

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

Creates a new error ToolResult.

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.