Struct ToolResult 

pub struct ToolResult {
    pub content: Vec<Content>,
    pub is_error: Option<bool>,
    pub structured_content: Option<Value>,
    pub meta: Option<HashMap<String, Value>>,
}

Result from calling a tool.

Fields

content: Vec<Content>

Content blocks in the result

is_error: Option<bool>

Whether this result represents an error

structured_content: Option<Value>

Structured content conforming to the tool’s output schema

meta: Option<HashMap<String, Value>>

Extension metadata

Implementations

impl ToolResult

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

Create a text result.

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

Create an error result.

pub fn json<T>(value: &T) -> Result<ToolResult, Error>

where T: Serialize,

Create a JSON result with structured content.

pub fn empty() -> ToolResult

Create an empty result (no content).

pub fn is_error(&self) -> bool

Check if this result represents an error.

pub fn with_structured<T>(self, value: &T) -> ToolResult

where T: Serialize,

Add structured content to the result.

pub fn with_content(self, content: Content) -> ToolResult

Add additional content to the result.

pub fn with_image( self, data: impl Into<String>, mime_type: impl Into<String>, ) -> ToolResult

Add image content to the result.

pub fn with_meta(self, meta: HashMap<String, Value>) -> ToolResult

Set metadata.

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

Get the first text content if present.

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<(), Error>

Formats the value using the given formatter.

impl Default for ToolResult

fn default() -> ToolResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoToolResult for ToolResult

fn into_tool_result(self) -> ToolResult

Convert this value into a 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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolResult