Struct ToolResult 

pub struct ToolResult {
    pub content: Vec<ToolResultBlock>,
    pub is_error: bool,
    pub details: Value,
    pub terminate: bool,
    pub narration: Option<String>,
}

Result of a tool execution.

Always contains content blocks visible to the model. details is arbitrary structured metadata for logs / UI / replay; the model never sees it directly. terminate is the unanimous-vote signal.

narration is an optional row-caption sentence shown to the user. It is owned by the tool (or a product-level after-hook) and should be derived from typed tool state such as path, query, exit code, or byte count. The generic loop does not infer narration from private model deliberation.

Fields

content: Vec<ToolResultBlock>

is_error: bool

details: Value

terminate: bool

narration: Option<String>

Implementations

impl ToolResult

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

Convenience: a plain-text successful result.

pub fn terminal(text: impl Into<String>) -> Self

Convenience: a plain-text terminal result (vote to end the run).

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

Convenience: an error result. The loop treats this as a context event, not a fatal — the model can recover.

pub fn with_narration(self, narration: impl Into<String>) -> Self

Attach a one-sentence diary entry in the user’s voice. Whitespace-only input is dropped to keep the diary clean. Trims surrounding whitespace so call sites can hand in templated multi-line strings.

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.