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>) -> Self

Construct literal text output.

pub fn json(value: Value) -> Self

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<Self, ToolExecutionError>

Constructs explicit model content, rejecting an empty block list. Use Self::text with "" to represent an empty text result.

pub fn one(content: ToolResultContent) -> Self

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) -> Self

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolOutput

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&str> for ToolOutput

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for ToolOutput

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<ToolResultContent> for ToolOutput

fn from(content: ToolResultContent) -> Self

Converts to this type from the input type.

impl From<Value> for ToolOutput

fn from(value: Value) -> Self

Converts to this type from the input type.

impl PartialEq for ToolOutput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolOutput

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

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<Self, Self::Error>

Performs the conversion.