Struct ToolOutput 

pub struct ToolOutput { /* private fields */ }

The canonical model-visible output produced by a tool.

Every output is stored as one or more typed ToolResultContent blocks. Ordinary serializable Rust values are converted through IntoToolOutput: values that serialize as JSON strings become literal text blocks and all other values become structured JSON blocks. An explicit serde_json::Value, including a JSON string, stays JSON. Multimodal tools opt in explicitly with Self::content. Rig never reparses text as JSON to guess whether it represents rich content.

Implementations

impl ToolOutput

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

Construct literal text output.

pub fn json(value: Value) -> ToolOutput

Construct structured JSON output.

Unlike an ordinary Rust string tool output, an explicit JSON string stays a JSON content block.

pub fn content( content: Vec<ToolResultContent>, ) -> Result<ToolOutput, ToolExecutionError>

Construct explicit model content.

Rejects an empty list. On main the argument type made emptiness unrepresentable; as a Vec the check lives here instead, because this is the one funnel every multi-block construction passes through — tools returning ToolOutput directly and hooks rewriting one included. A zero-block tool result cannot be sent (the request boundary rejects it), so rejecting at construction surfaces the defect where it is made rather than one request later. A tool with a genuinely empty result returns one empty text block (Self::text with "").

pub fn one(content: ToolResultContent) -> ToolOutput

Construct one explicit model-content block.

pub fn as_text(&self) -> Option<&str>

Return literal text when this output is exactly one plain text block.

pub fn as_json(&self) -> Option<&Value>

Return structured JSON when this output is exactly one JSON block.

pub fn as_content(&self) -> &[ToolResultContent]

Borrow the canonical ordered content blocks.

pub fn into_content(self) -> Vec<ToolResultContent>

Convert this output into the canonical message content sent to a model.

pub fn render(&self) -> String

Render a stable text representation for telemetry and diagnostics.

This is a terminal rendering operation; the returned text is never used to reconstruct structured output.

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, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&str> for ToolOutput

fn from(text: &str) -> ToolOutput

Converts to this type from the input type.

impl From<String> for ToolOutput

fn from(text: String) -> ToolOutput

Converts to this type from the input type.

impl From<ToolResultContent> for ToolOutput

fn from(content: ToolResultContent) -> ToolOutput

Converts to this type from the input type.

impl From<Value> for ToolOutput

fn from(value: Value) -> ToolOutput

Converts to this type from the input type.

impl IntoToolOutput for ToolOutput

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.

impl PartialEq for ToolOutput

fn eq(&self, other: &ToolOutput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ToolOutput

impl TryFrom<Vec<ToolResultContent>> for ToolOutput

type Error = ToolExecutionError

The type returned in the event of a conversion error.

fn try_from( content: Vec<ToolResultContent>, ) -> Result<ToolOutput, <ToolOutput as TryFrom<Vec<ToolResultContent>>>::Error>

Performs the conversion.