Struct ruma_events::room::message::ImageMessageEventContent

#[non_exhaustive]
pub struct ImageMessageEventContent {
    pub body: String,
    pub url: Option<MxcUri>,
    pub file: Option<Box<EncryptedFile>>,
    pub info: Option<Box<ImageInfo>>,
}

The payload for an image message.

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.

body: String

A textual representation of the image.

This could be the alt text of the image, the filename of the image, or some kind of content description for accessibility e.g. “image attachment”.

url: Option<MxcUri>

The URL to the image.

file: Option<Box<EncryptedFile>>

Information on the encrypted image.

Required if image is encrypted.

info: Option<Box<ImageInfo>>

Metadata about the image referred to in url.

Implementations

impl ImageMessageEventContent

pub fn plain(body: String, url: MxcUri, info: Option<Box<ImageInfo>>) -> Self

Creates a new non-encrypted ImageMessageEventContent with the given body, url and optional extra info.

pub fn encrypted(body: String, file: EncryptedFile) -> Self

Creates a new encrypted ImageMessageEventContent with the given body and encrypted file.

Trait Implementations

impl Clone for ImageMessageEventContent

fn clone(&self) -> ImageMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageMessageEventContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageMessageEventContent

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

Serialize this value into the given Serde serializer.