Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub role: Role,
    pub content: Vec<ContentPart>,
}
Expand description

A single turn in the conversation.

content is always a list of ContentParts. Codecs that accept a string shorthand are responsible for collapsing a single ContentPart::Text to a bare string at encode time.

Message is an open data carrier: codec/runnable internals pattern-match exhaustively against the IR, so the type stays constructable via struct-literal syntax. New IR signals land as additional ContentPart variants (which ContentPart’s #[non_exhaustive] covers) or as new helpers on Message.

Fields§

§role: Role

Who authored this message.

§content: Vec<ContentPart>

One or more content parts. Empty content is permitted (some providers emit empty assistant messages alongside tool calls).

Implementations§

Source§

impl Message

Source

pub fn new(role: Role, content: Vec<ContentPart>) -> Self

Construct a message with a typed role + content list. Use the role-specific helpers (user / assistant / system / tool_*) for the common single-text-part cases; reach for new when assembling multi-part content (multimodal, tool-use blocks, etc.).

Source

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

Convenience: user message with a single text part.

Source

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

Convenience: assistant message with a single text part.

Source

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

Convenience: system message with a single text part.

Source

pub fn tool_result( tool_use_id: impl Into<String>, name: impl Into<String>, output: impl Into<String>, ) -> Self

Convenience: tool message wrapping a tool’s reply to a prior ContentPart::ToolUse. Mirrors LangChain’s ToolMessage(content=…, tool_call_id=…, name=…) shape so the RAG / agent loop reads as a one-line append after each tool call instead of hand-constructing a Message { role: Role::Tool, content: vec![ContentPart::ToolResult { … }] }.

Both tool_use_id and name are required: Anthropic / OpenAI / Bedrock correlate by id, but Gemini’s functionResponse keys by name. Carrying both keeps the IR provider-neutral so a single agent harness works across all four codecs without per-vendor adaptation.

output accepts any string-like — for structured payloads, use Self::tool_result_json and the codec will emit native JSON (or stringify with a LossyEncode warning if the provider lacks structured tool-result support).

Source

pub fn tool_result_json( tool_use_id: impl Into<String>, name: impl Into<String>, output: Value, ) -> Self

Same as Self::tool_result but carries a structured JSON payload. Use when the tool returns objects/arrays the model should reason over without re-parsing a stringified blob.

Source

pub fn tool_error( tool_use_id: impl Into<String>, name: impl Into<String>, output: impl Into<String>, ) -> Self

Same as Self::tool_result but flagged as an error reply. Anthropic and Bedrock surface the is_error flag natively; other codecs prefix the text or emit a LossyEncode warning.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

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 Message

Source§

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

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

impl<'de> Deserialize<'de> for Message

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Message

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Message

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Message

Source§

impl StructuralPartialEq for Message

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,