Enum UIMessagePart 

pub enum UIMessagePart {
    Text(TextPart),
    Reasoning(ReasoningPart),
    File(FilePart),
    Tool(ToolPart),
    SourceUrl(SourceUrlPart),
    SourceDocument(SourceDocumentPart),
    StepStart,
    Data(DataPart),
}

AI SDK UIMessage part types.

A message consists of one or more parts, each representing a different type of content (text, file, tool call, reasoning, etc.).

The format uses a type field to distinguish between different part types:

{ "type": "text", "text": "Hello" }
{ "type": "file", "mediaType": "image/png", "url": "..." }
{ "type": "tool-get_weather", "toolCallId": "...", "state": "input-available" }
{ "type": "data-usage", "data": {...} }

Variants

Text(TextPart)

Text content

Reasoning(ReasoningPart)

Reasoning/thinking content

File(FilePart)

File attachment

Tool(ToolPart)

Tool invocation (AI SDK 5.x ToolUIPart format)

SourceUrl(SourceUrlPart)

URL source

SourceDocument(SourceDocumentPart)

Document source

StepStart

Step start marker

Data(DataPart)

Dynamic data part (data-{name} pattern)

Implementations

impl UIMessagePart

pub fn as_text(&self) -> Option<&str>

Gets the text content if this is a Text part.

Example

use rig_ai_sdk::UIMessagePart;

let part = UIMessagePart::Text {
    text: "Hello".to_string(),
    state: None,
    provider_metadata: None,
};
assert_eq!(part.as_text(), Some("Hello"));

pub fn is_text(&self) -> bool

Returns true if this is a Text part.

pub fn is_reasoning(&self) -> bool

Returns true if this is a Reasoning part.

pub fn is_tool(&self) -> bool

Returns true if this is a tool invocation.

pub fn as_tool(&self) -> Option<&ToolPart>

Gets the tool part if this is a Tool.

pub fn is_data(&self) -> bool

Returns true if this is a Data part.

pub fn as_data(&self) -> Option<&DataPart>

Gets the data content if this is a Data part.

pub fn as_file(&self) -> Option<(&str, &str, Option<&String>)>

Gets the file content if this is a File part.

Returns a tuple of (media_type, url, optional_filename).

pub fn state(&self) -> Option<PartState>

Gets the streaming state if applicable.

Returns Some(state) for Text and Reasoning parts, None otherwise.

pub fn media_type_kind(&self) -> Option<MediaType>

Parses the media type into a MediaType category.

Returns Some(MediaType) for File and SourceDocument parts, None otherwise.

Trait Implementations

impl Clone for UIMessagePart

fn clone(&self) -> UIMessagePart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UIMessagePart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UIMessagePart

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UIMessagePart

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

where __S: Serializer,

Serialize this value into the given Serde serializer.