Struct ToolMessage 

pub struct ToolMessage {
    pub id: MessageId,
    pub content: String,
    pub role: Role,
    pub tool_call_id: ToolCallId,
    pub error: Option<String>,
}

A tool message containing the result of a tool/function call.

Fields

id: MessageId

Unique identifier for this message.

content: String

The text content (tool result).

role: Role

The role (always Tool).

tool_call_id: ToolCallId

The ID of the tool call this result corresponds to.

error: Option<String>

Optional error message if the tool call failed.

Implementations

impl ToolMessage

pub fn new( id: impl Into<MessageId>, content: String, tool_call_id: impl Into<ToolCallId>, ) -> ToolMessage

Creates a new tool message with the given ID, content, and tool call ID.

pub fn with_error(self, error: String) -> ToolMessage

Sets the error for this message.

Trait Implementations

impl Clone for ToolMessage

fn clone(&self) -> ToolMessage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolMessage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolMessage

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 ToolMessage