Struct UserMessage 

#[non_exhaustive]
pub struct UserMessage {
    pub content: UserContent,
    pub cache: Option<CacheBreakpoint>,
    pub provider_data: ProviderData,
    pub app_data: ExtraMap,
}

User input.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: UserContent

Text or multimodal content.

cache: Option<CacheBreakpoint>

Marks the end of a cacheable prefix.

provider_data: ProviderData

Provider-specific data.

app_data: ExtraMap

Application data: never read by adapters or sent to a provider (see Application data).

Implementations

impl UserMessage

pub fn new(content: impl Into<UserContent>) -> Self

Create a user message.

pub fn text_segments(&self) -> impl Iterator<Item = &str>

Iterate over the text segments; see Message::text_segments.

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

Concatenated text, or None when there is none; see Message::text.

Trait Implementations

impl Clone for UserMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UserMessage

impl From<UserMessage> for Message

fn from(value: UserMessage) -> Self

Converts to this type from the input type.

impl PartialEq for UserMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UserMessage

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 UserMessage