Struct ToolResult 

pub struct ToolResult {
    pub success: bool,
    pub result: String,
    pub display_preference: Option<String>,
    pub images: Vec<ToolResultImage>,
}

Represents the result of executing a tool.

Fields

success: bool

result: String

display_preference: Option<String>

images: Vec<ToolResultImage>

Images returned by the tool (e.g. screenshots). Empty for the vast majority of tools; populated only by image-producing tools like MCP screenshot. Defaults to empty so existing serialized results load.

Implementations

impl ToolResult

pub fn text(success: bool, result: impl Into<String>) -> ToolResult

Construct a text-only result (no images). Convenience for the common case.

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 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.