Struct ImageEventContent

#[non_exhaustive]
pub struct ImageEventContent {
    pub text: TextContentBlock,
    pub file: FileContentBlock,
    pub image_details: Option<ImageDetailsContentBlock>,
    pub thumbnail: ThumbnailContentBlock,
    pub caption: Option<CaptionContentBlock>,
    pub alt_text: Option<AltTextContentBlock>,
    pub automated: bool,
    pub relates_to: Option<Relation<ImageEventContentWithoutRelation>>,
}

The payload for an extensible image message.

This is the new primary type introduced in MSC3552 and should only be sent in rooms with a version that supports it. This type replaces both the m.room.message type with msgtype: "m.image" and the m.sticker type. To replace the latter, sticker must be set to true in image_details. See the documentation of the message module for more information.

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.

text: TextContentBlock

The text representation of the message.

file: FileContentBlock

The file content of the message.

image_details: Option<ImageDetailsContentBlock>

The image details of the message, if any.

thumbnail: ThumbnailContentBlock

The thumbnails of the message, if any.

This is optional and defaults to an empty array.

caption: Option<CaptionContentBlock>

The caption of the message, if any.

alt_text: Option<AltTextContentBlock>

The alternative text of the image, for accessibility considerations, if any.

automated: bool

Whether this message is automated.

relates_to: Option<Relation<ImageEventContentWithoutRelation>>

Information about related messages.

Implementations

impl ImageEventContent

pub fn new(text: TextContentBlock, file: FileContentBlock) -> Self

Creates a new ImageEventContent with the given fallback representation and file.

pub fn with_plain_text( plain_text: impl Into<String>, file: FileContentBlock, ) -> Self

Creates a new ImageEventContent with the given plain text fallback representation and file.

Trait Implementations

impl Clone for ImageEventContent

fn clone(&self) -> ImageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for ImageEventContent

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl From<ImageEventContent> for AnyMessageLikeEventContent

fn from(c: ImageEventContent) -> Self

Converts to this type from the input type.

impl From<ImageEventContent> for ImageEventContentWithoutRelation

fn from(c: ImageEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for ImageEventContent

type Redacted = RedactedImageEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedImageEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for ImageEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for ImageEventContent

const TYPE: &'static str = "org.matrix.msc1767.image"

The event type.

impl MessageLikeEventContent for ImageEventContent