Struct ToolResult 

pub struct ToolResult {
    pub success: bool,
    pub output: Option<String>,
    pub error: Option<String>,
    pub metadata: HashMap<String, Value>,
    pub duration_ms: Option<u64>,
    pub llm_suffix: Option<String>,
}

Result of a tool execution.

Fields

success: bool

Whether the tool executed successfully.

output: Option<String>

Tool output text (for successful results).

error: Option<String>

Error message (for failed results).

metadata: HashMap<String, Value>

Additional metadata (tool-specific).

duration_ms: Option<u64>

Execution duration in milliseconds (populated by the registry).

llm_suffix: Option<String>

Hidden suffix appended to the tool result for the LLM but not shown in the UI. Used to silently guide LLM behavior on errors (e.g., retry hints).

Implementations

impl ToolResult

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

Create a successful result.

pub fn ok_with_metadata( output: impl Into<String>, metadata: HashMap<String, Value>, ) -> Self

Create a successful result with metadata.

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

Create a failed result.

pub fn with_llm_suffix(self, suffix: impl Into<String>) -> Self

Attach an LLM-only suffix to this result.

pub fn from_error(err: ToolError) -> Self

Create a result from a ToolError.

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