Skip to main content

Message

Enum Message 

Source
pub enum Message {
    System {
        content: String,
    },
    User {
        content: Vec<UserContent>,
    },
    Assistant {
        id: Option<String>,
        content: Vec<AssistantContent>,
    },
}
Expand description

A provider-agnostic chat message.

Messages are role-tagged and may contain one or many content items, including text, images, audio, documents, tool calls, and tool results. Provider modules are responsible for translating these generic messages into provider-native request bodies. That conversion may be lossy when a provider does not support a particular content type.

Variants§

§

System

System message containing instruction text.

Fields

§content: String
§

User

User message containing one or more content types defined by UserContent.

Fields

§content: Vec<UserContent>
§

Assistant

Assistant message containing one or more content types defined by AssistantContent.

Fields

§id: Option<String>

Provider-assigned assistant message ID, when available.

Implementations§

Source§

impl Message

Source

pub fn rag_text(&self) -> Option<String>

This helper method is primarily used to extract the first string prompt from a Message. Since Message might have more than just text content, we need to find the first text.

Source

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

Helper constructor to make creating system messages easier.

Source

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

Helper constructor to make creating user messages easier.

Source

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

Helper constructor to make creating assistant messages easier.

Source

pub fn tool_result( call: impl Into<String>, name: impl Into<String>, content: impl Into<String>, ) -> Message

Helper constructor to make creating tool result messages easier. call is the answered call’s correlation handle — echo ToolCall::id; it is never recorded as a provider-issued identifier (see UserContent::tool_result). name is the executed tool’s name.

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

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

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

Source§

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

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

impl From<&Message> for Message

Source§

fn from(msg: &Message) -> Message

Converts to this type from the input type.
Source§

impl From<&String> for Message

Source§

fn from(value: &String) -> Message

Converts to this type from the input type.
Source§

impl From<&str> for Message

Source§

fn from(value: &str) -> Message

Converts to this type from the input type.
Source§

impl From<AssistantContent> for Message

Source§

fn from(content: AssistantContent) -> Message

Converts to this type from the input type.
Source§

impl From<Audio> for Message

Source§

fn from(value: Audio) -> Message

Converts to this type from the input type.
Source§

impl From<Document> for Message

Source§

fn from(value: Document) -> Message

Converts to this type from the input type.
Source§

impl From<Image> for Message

Source§

fn from(value: Image) -> Message

Converts to this type from the input type.
Source§

impl From<Message> for Message

Conversion from provider Message to a completion message. This is needed so that responses can be converted back into chat history.

An assistant message with empty content and no thinking or tool calls converts to empty message content — no fabricated empty-text block. Such a message cannot be replayed through the request boundary (validate_message_content rejects a content-less assistant message); callers ingesting raw Ollama history should filter empty assistant messages rather than expect rig to invent content for them. The agent loop never produces this shape: it drops empty turns before history.

Source§

fn from(msg: Message) -> Message

Converts to this type from the input type.
Source§

impl From<String> for Message

Source§

fn from(value: String) -> Message

Converts to this type from the input type.
Source§

impl From<Text> for Message

Source§

fn from(value: Text) -> Message

Converts to this type from the input type.
Source§

impl From<ToolCall> for Message

Source§

fn from(value: ToolCall) -> Message

Converts to this type from the input type.
Source§

impl From<ToolResult> for Message

Source§

fn from(value: ToolResult) -> Message

Converts to this type from the input type.
Source§

impl From<ToolResultContent> for Message

Source§

fn from(tool_result_content: ToolResultContent) -> Message

Converts to this type from the input type.
Source§

impl From<UserContent> for Message

Source§

fn from(content: UserContent) -> Message

Converts to this type from the input type.
Source§

impl From<Vec<AssistantContent>> for Message

Source§

fn from(content: Vec<AssistantContent>) -> Message

Converts to this type from the input type.
Source§

impl From<Vec<UserContent>> for Message

Source§

fn from(content: Vec<UserContent>) -> Message

Converts to this type from the input type.
Source§

impl PartialEq for Message

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Message

Source§

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

impl StructuralPartialEq for Message

Source§

impl TryFrom<Message> for Message

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Message

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Vec<Message>

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Message

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Content

Source§

type Error = MessageError

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

fn try_from( msg: Message, ) -> Result<Content, <Content as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Step

Source§

type Error = MessageError

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

fn try_from(message: Message) -> Result<Step, <Step as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Vec<Message>

Conversion from an internal Rig message (crate::message::Message) to a provider Message. (Only User and Assistant variants are supported.)

Source§

type Error = MessageError

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

fn try_from( internal_msg: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Vec<Message>

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Message

Source§

type Error = MessageError

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

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Vec<InputItem>

Source§

type Error = CompletionError

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

fn try_from( value: Message, ) -> Result<Vec<InputItem>, <Vec<InputItem> as TryFrom<Message>>::Error>

Performs the conversion.
Source§

impl TryFrom<Message> for Vec<Message>

Source§

type Error = CompletionError

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

fn try_from( msg: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneDebuggableStorage for T

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> DebuggableStorage for T
where T: Any + Send + Sync + Debug,

Source§

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

Source§

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

Source§

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

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> 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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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