Struct TextMessageStartEvent 

pub struct TextMessageStartEvent {
    pub base: BaseEvent,
    pub message_id: MessageId,
    pub role: TextMessageRole,
    pub name: Option<String>,
    pub subagent_run_id: Option<SubagentRunId>,
}

Opens a text message. Every following TEXT_MESSAGE_CONTENT with the same message_id appends to it, until TEXT_MESSAGE_END.

Fields

base: BaseEvent

Timestamp and raw provider event.

message_id: MessageId

Id of the message being opened.

role: TextMessageRole

Who is speaking. Defaults to assistant when omitted, and a JSON null reads as omitted.

name: Option<String>

Display name for the author.

subagent_run_id: Option<SubagentRunId>

The subagent that produced this event; absent means the parent agent. A JSON null is rejected — see crate::event::subagent.

Implementations

impl TextMessageStartEvent

pub fn new(message_id: impl Into<MessageId>, role: TextMessageRole) -> Self

Opens a message with the given id and role.

Trait Implementations

impl Clone for TextMessageStartEvent

fn clone(&self) -> TextMessageStartEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for TextMessageStartEvent

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

impl Debug for TextMessageStartEvent

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

Formats the value using the given formatter.

impl Default for TextMessageStartEvent

fn default() -> TextMessageStartEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextMessageStartEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TextMessageStartEvent> for Event

fn from(payload: TextMessageStartEvent) -> Self

Converts to this type from the input type.

impl JsonSchema for TextMessageStartEvent

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 TextMessageStartEvent

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

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 TextMessageStartEvent

impl ToSchema for TextMessageStartEvent

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.