Struct ToolOutput 

pub struct ToolOutput {
    pub output: ToolOutputBody,
    pub success: bool,
    pub metadata: Option<Box<RawValue>>,
    /* private fields */
}

Complete output of one tool invocation.

Use Self::text, Self::json, or Self::content for successful results. Self::error creates a structured model-visible failure without turning the handler invocation itself into an error.

Fields

output: ToolOutputBody

Model-visible output body.

success: bool

Whether the remote or local operation succeeded.

metadata: Option<Box<RawValue>>

Optional validated opaque metadata for events and adapters.

Implementations

impl ToolOutput

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

Creates a successful plain-text output.

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

Creates a model-visible failed output.

pub fn json(output: &impl Serialize) -> ToolOutput

Serializes one successful function result as JSON text.

pub fn from_json(output: Value, success: bool) -> ToolOutput

Creates a JSON result with an explicit success state.

Code Mode receives the typed JSON value while the Responses API receives its serialized text representation.

pub const fn content(output: Vec<ToolOutputContent>) -> ToolOutput

Creates a successful multimodal output.

pub fn with_metadata(self, metadata: impl Serialize) -> ToolOutput

Attaches validated opaque metadata.

An encoding failure converts this output into a model-visible failure.