Struct ruma_common::events::room::message::ImageMessageEventContent

pub struct ImageMessageEventContent {
    pub body: String,
    pub source: MediaSource,
    pub info: Option<Box<ImageInfo>>,
    pub message: Option<MessageContent>,
    pub file: Option<FileContent>,
    pub image: Option<Box<ImageContent>>,
    pub thumbnail: Option<Vec<ThumbnailContent>>,
    pub caption: Option<MessageContent>,
}

Available on crate feature events only.

The payload for an image message.

With the unstable-msc3552 feature, this type contains the transitional format of ImageEventContent. See the documentation of the message module for more information.

Fields

body: String

A textual representation of the image.

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”.

source: MediaSource

The source of the image.

info: Option<Box<ImageInfo>>

Metadata about the image referred to in source.

message: Option<MessageContent>

Available on crate feature unstable-msc3552 only.

Extensible-event text representation of the message.

If present, this should be preferred over the body field.

file: Option<FileContent>

Available on crate feature unstable-msc3552 only.

Extensible-event file content of the message.

If present, this should be preferred over the source and info fields.

image: Option<Box<ImageContent>>

Available on crate feature unstable-msc3552 only.

Extensible-event image info of the message.

If present, this should be preferred over the info field.

thumbnail: Option<Vec<ThumbnailContent>>

Available on crate feature unstable-msc3552 only.

Extensible-event thumbnails of the message.

If present, this should be preferred over the info field.

caption: Option<MessageContent>

Available on crate feature unstable-msc3552 only.

Extensible-event captions of the message.

Implementations

impl ImageMessageEventContent

pub fn plain(
    body: String,
    url: OwnedMxcUri,
    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.

pub fn from_extensible_content(
    message: MessageContent,
    file: FileContent,
    image: Box<ImageContent>,
    thumbnail: Vec<ThumbnailContent>,
    caption: Option<MessageContent>
) -> Self

Available on crate feature unstable-msc3552 only.

Create a new ImageMessageEventContent with the given message, file info, image info, thumbnails and captions.

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.