Skip to main content

ChatMessage

Struct ChatMessage 

Source
pub struct ChatMessage {
    pub role: ChatRole,
    pub content: String,
    pub tool_calls: Vec<ToolCall>,
    pub tool_call_id: Option<String>,
    pub tool_name: Option<String>,
    pub attachments: Vec<ChatAttachment>,
    pub attachment_refs: Vec<String>,
}
Expand description

A chat turn: role and content plus optional tool calls, tool-result routing, and attachments.

Fields§

§role: ChatRole

The author.

§content: String

The visible text content.

§tool_calls: Vec<ToolCall>

Tool calls this (assistant) turn emitted.

§tool_call_id: Option<String>

The id of the tool call this (tool) turn answers.

§tool_name: Option<String>

The name of the tool this (tool) turn answers.

§attachments: Vec<ChatAttachment>

Attachments (images forwarded, documents inlined).

§attachment_refs: Vec<String>

Content-addressed references to attachments held elsewhere.

Implementations§

Source§

impl ChatMessage

Source

pub fn new(role: ChatRole, content: impl Into<String>) -> Self

A plain message with just a role and content.

Source

pub fn payload_value(&self) -> JsonValue

The outbound wire object: document blocks prepended to the content, tool calls / tool routing carried through, and images base64-encoded into an images array.

Source

pub fn from_payload(value: &JsonValue) -> Option<Self>

Leniently parse one message object, returning None if it lacks a valid role. Unknown fields and malformed tool calls are dropped, not rejected.

Source

pub fn parse_strict( value: &JsonValue, index: usize, ) -> Result<Self, ChatWireError>

Strictly parse the message at index, rejecting a non-object, a missing or unknown role, or non-string content.

Source

pub fn parse_all(payload: &JsonValue) -> Result<Vec<Self>, ChatWireError>

Parse the whole chat request: a messages array (strictly, index by index) or, failing that, a single prompt string as one user turn.

Source

pub fn inlined_tool_transcript(&self) -> ChatMessage

This message with any assistant tool calls folded into the visible text as <tool_call>{…}</tool_call> blocks — the transcript form for a model that takes tool history as plain text. A non-assistant or call-less message is returned unchanged.

Trait Implementations§

Source§

impl Clone for ChatMessage

Source§

fn clone(&self) -> ChatMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChatMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ChatMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ChatMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.