Struct ToolOutput 

pub struct ToolOutput {
    pub content: String,
    pub compact: Option<String>,
    pub is_error: bool,
    pub terminate: bool,
}

Output from a tool execution, carrying both the full content (shown in expanded mode / sent to the LLM) and an optional compact label for collapsed UI display.

Fields

content: String

Full content sent to the LLM and shown when expanded.

compact: Option<String>

Compact label shown in collapsed mode (e.g. read docs docs/README.md). When None, the full content is always shown.

is_error: bool

Whether the result is an error.

terminate: bool

When true, the agent loop stops after this batch of tool calls (no more LLM calls). Pi-compatible: terminate on tool results.

Implementations

impl ToolOutput

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

pub fn ok_with_compact( content: impl Into<String>, compact: impl Into<String>, ) -> Self

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

pub fn with_terminate(self, terminate: bool) -> Self

Mark this tool output as terminal — the agent loop will stop after this batch of tool calls when ALL tools in the batch return terminate=true.

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutput

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

Formats the value using the given formatter.