Enum Message 

pub enum Message {
    Developer(DeveloperMessage),
    System(SystemMessage),
    Assistant(AssistantMessage),
    User(UserMessage),
    Tool(ToolMessage),
    Activity(ActivityMessage),
    Reasoning(ReasoningMessage),
}

A message in a thread, discriminated by its role.

Variants

Developer(DeveloperMessage)

See DeveloperMessage.

System(SystemMessage)

See SystemMessage.

Assistant(AssistantMessage)

See AssistantMessage.

User(UserMessage)

See UserMessage.

Tool(ToolMessage)

See ToolMessage.

Activity(ActivityMessage)

See ActivityMessage.

Reasoning(ReasoningMessage)

See ReasoningMessage.

Implementations

impl Message

pub fn user(id: impl Into<MessageId>, content: impl Into<UserContent>) -> Self

Builds a user message carrying plain text.

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

Builds an assistant message carrying plain text.

pub fn system(id: impl Into<MessageId>, content: impl Into<String>) -> Self

Builds a system message.

pub fn developer(id: impl Into<MessageId>, content: impl Into<String>) -> Self

Builds a developer message.

pub fn tool( id: impl Into<MessageId>, tool_call_id: impl Into<ToolCallId>, content: impl Into<String>, ) -> Self

Builds a tool result message.

pub const fn id(&self) -> &MessageId

The message id, whatever the role.

pub const fn role(&self) -> Role

The role, whatever the variant.

pub const fn subagent_run_id(&self) -> Option<&SubagentRunId>

The subagent that produced the message, whatever the role. None means the parent agent. See crate::event::subagent.

pub fn set_subagent_run_id(&mut self, subagent_run_id: Option<SubagentRunId>)

Sets or clears the subagent the message is attributed to.

pub const fn metadata(&self) -> Option<&JsonObject>

The message’s metadata, whatever the role. See crate::metadata.

pub fn metadata_mut(&mut self) -> &mut Option<JsonObject>

The metadata slot, for a consumer merging an event’s metadata into the message it builds — see merge_metadata_into.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Message

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Message

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ActivityMessage> for Message

fn from(value: ActivityMessage) -> Self

Converts to this type from the input type.

impl From<AssistantMessage> for Message

fn from(value: AssistantMessage) -> Self

Converts to this type from the input type.

impl From<DeveloperMessage> for Message

fn from(value: DeveloperMessage) -> Self

Converts to this type from the input type.

impl From<ReasoningMessage> for Message

fn from(value: ReasoningMessage) -> Self

Converts to this type from the input type.

impl From<SystemMessage> for Message

fn from(value: SystemMessage) -> Self

Converts to this type from the input type.

impl From<ToolMessage> for Message

fn from(value: ToolMessage) -> Self

Converts to this type from the input type.

impl From<UserMessage> for Message

fn from(value: UserMessage) -> Self

Converts to this type from the input type.

impl JsonSchema for Message

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Message

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

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 Message

impl ToSchema for Message

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.