Enum ToolResult 

pub enum ToolResult {
    Done,
    Text {
        text: String,
    },
    Tsv {
        text: String,
    },
    Json {
        value: Value,
    },
    Binary {
        mime: String,
        content: Vec<u8>,
    },
    Error {
        message: String,
    },
    Parts {
        parts: Vec<ToolResultPart>,
    },
}

Final structured result from a tool execution.

This keeps successful content and tool-level failures in distinct variants so UIs and runtimes do not need to infer errors from free-form strings.

Example

use aither::llm::tool::ToolResult;

fn search_tool() -> ToolResult {
    ToolResult::text("Found 3 results...")
}

fn delete_tool() -> ToolResult {
    ToolResult::Done
}

Variants

Done

Tool completed with no output to return.

Text

UTF-8 plain text output.

Fields

text: String

Plain text content.

Tsv

Tab-separated tabular output.

Fields

text: String

TSV content.

Json

Structured JSON output.

Fields

value: Value

JSON content.

Binary

Binary or media payload.

Fields

mime: String

MIME type of the payload (for example image/png).

content: Vec<u8>

Raw content bytes.

Error

Tool-level error. This is distinct from transport/runtime failures.

Fields

message: String

Tool-level error message.

Parts

Several content items produced by one tool call.

A single call can legitimately yield more than one payload — for example a relayed MCP tool result that pairs explanatory text with a screenshot. Parts never nest and never carry errors: tool-level failures stay on ToolResult::Error.

Fields

parts: Vec<ToolResultPart>

Ordered content items.

Implementations

impl ToolResult

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

Creates a plain text result.

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

Creates a TSV result.

pub fn json<T: Serialize>(value: &T) -> Result<Self>

Creates a JSON result from a serializable value.

Errors

Returns an error if serialization fails.

pub const fn json_value(value: Value) -> Self

Creates a JSON result from an already-materialized JSON value.

pub fn image(data: Vec<u8>, media_type: &str) -> Self

Creates an image result.

pub fn binary(data: Vec<u8>) -> Self

Creates a binary result.

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

Creates a typed tool error result.

pub fn parts(parts: Vec<ToolResultPart>) -> Self

Creates a multi-part result.

An empty part list collapses to ToolResult::Done and a single part collapses to the matching single-payload variant, so callers that conditionally accumulate parts never produce a degenerate Parts.

pub const fn is_done(&self) -> bool

Returns true if this is a Done variant.

pub const fn is_error(&self) -> bool

Returns true if this is a typed tool error.

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

Returns plain textual content when every payload this result carries is text-like.

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

Returns the error message if this is a typed tool error.

pub fn render_for_model(&self) -> Result<String>

Projects the result into a textual representation safe to re-inject into model context.

Errors

Returns an error if JSON serialization fails.

pub fn render_for_cli(&self) -> Result<String>

Renders the result for CLI display.

Errors

Returns an error if JSON serialization fails.

pub fn mime(&self) -> Option<Mime>

Parses and returns the MIME type when this result carries binary content.

A multi-part result yields a MIME type only when it holds exactly one binary part; mixed content has no single type to report.

pub fn content(&self) -> Option<&[u8]>

Returns raw bytes when this result carries binary content.

Follows the same single-binary rule as Self::mime.

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 Eq for ToolResult

impl IntoToolResult for ToolResult

fn into_tool_result(self) -> Result<ToolResult>

Converts the value into a final ToolResult.

impl PartialEq for ToolResult

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ToolResult