Struct ImageMessageEventContent

#[non_exhaustive]
pub struct ImageMessageEventContent {
    pub body: String,
    pub formatted: Option<FormattedBody>,
    pub filename: Option<String>,
    pub source: MediaSource,
    pub info: Option<Box<ImageInfo>>,
}

Available on crate feature events only.

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.

If the filename field is not set or has the same value, this is the filename of the uploaded file. Otherwise, this should be interpreted as a user-written media caption.

formatted: Option<FormattedBody>

Formatted form of the message body.

This should only be set if the body represents a caption.

filename: Option<String>

The original filename of the uploaded file as deserialized from the event.

It is recommended to use the filename method to get the filename which automatically falls back to the body field when the filename field is not set.

source: MediaSource

The source of the image.

info: Option<Box<ImageInfo>>

Metadata about the image referred to in source.

Implementations

impl ImageMessageEventContent

pub fn new(body: String, source: MediaSource) -> ImageMessageEventContent

Creates a new ImageMessageEventContent with the given body and source.

pub fn plain(body: String, url: OwnedMxcUri) -> ImageMessageEventContent

Creates a new non-encrypted ImageMessageEventContent with the given body and url.

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

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

pub fn info( self, info: impl Into<Option<Box<ImageInfo>>>, ) -> ImageMessageEventContent

Creates a new ImageMessageEventContent from self with the info field set to the given value.

Since the field is public, you can also assign to it directly. This method merely acts as a shorthand for that, because it is very common to set this field.

pub fn filename(&self) -> &str

Computes the filename of the image as defined by the spec.

This differs from the filename field as this method falls back to the body field when the filename field is not set.

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

Returns the caption for the image as defined by the spec.

In short, this is the body field if the filename field exists and has a different value, otherwise the media file does not have a caption.

pub fn formatted_caption(&self) -> Option<&FormattedBody>

Returns the formatted caption for the image as defined by the spec.

This is the same as caption, but returns the formatted body instead of the plain body.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<ImageMessageEventContent, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.