Struct UIMessage 

pub struct UIMessage {
    pub id: String,
    pub role: UIRole,
    pub metadata: Option<Value>,
    pub parts: Vec<UIMessagePart>,
}

A UI message with rich parts.

This is the source of truth for application state, representing the complete message including metadata, data parts, and all contextual information.

Fields

id: String

Unique identifier for this message.

role: UIRole

Role of the message sender.

metadata: Option<Value>

Optional metadata.

parts: Vec<UIMessagePart>

Message parts.

Implementations

impl UIMessage

pub fn new(id: impl Into<String>, role: UIRole) -> Self

Create a new UI message.

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

Create a user message.

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

Create an assistant message.

pub fn with_metadata(self, metadata: Value) -> Self

Add metadata.

pub fn with_part(self, part: UIMessagePart) -> Self

Add a part.

pub fn with_parts(self, parts: impl IntoIterator<Item = UIMessagePart>) -> Self

Add multiple parts.

pub fn with_text(self, text: impl Into<String>) -> Self

Add a text part.

pub fn text_content(&self) -> String

Get all text content concatenated.

Trait Implementations

impl Clone for UIMessage

fn clone(&self) -> UIMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UIMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UIMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UIMessage

fn eq(&self, other: &UIMessage) -> 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 UIMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UIMessage