Struct ruma_common::events::image::ImageEventContent

pub struct ImageEventContent {
    pub message: MessageContent,
    pub file: FileContent,
    pub image: Box<ImageContent>,
    pub thumbnail: Vec<ThumbnailContent>,
    pub caption: Option<MessageContent>,
    pub relates_to: Option<Relation>,
}

Available on crate features events and unstable-msc3552 only.

The payload for an extensible image message.

This is the new primary type introduced in MSC3552 and should not be sent before the end of the transition period. See the documentation of the message module for more information.

ImageEventContent can be converted to a RoomMessageEventContent with a MessageType::Image. You can convert it back with ImageEventContent::from_image_room_message().

Fields

message: MessageContent

The text representation of the message.

file: FileContent

The file content of the message.

image: Box<ImageContent>

The image content of the message.

thumbnail: Vec<ThumbnailContent>

The thumbnails of the message.

caption: Option<MessageContent>

The captions of the message.

relates_to: Option<Relation>

Information about related messages.

Implementations

impl ImageEventContent

pub fn plain(message: impl Into<String>, file: FileContent) -> Self

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

pub fn with_message(message: MessageContent, file: FileContent) -> Self

Creates a new non-encrypted ImageEventContent with the given message and file.

pub fn from_image_room_message(
    content: ImageMessageEventContent,
    relates_to: Option<Relation>
) -> Self

Create a new ImageEventContent from the given ImageMessageEventContent and optional relation.

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

Available on crate feature events only.

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

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

Available on crate feature events only.

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 RoomMessageEventContent

fn from(content: ImageEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for ImageEventContent

type Redacted = RedactedImageEventContent

Available on crate feature events only.

The redacted form of the event’s content.

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

Available on crate feature events only.

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 KIND: EventKind = ::ruma_common::events::EventKind::MessageLike{redacted: false,}

Available on crate feature events only.

The event’s “kind”.

const TYPE: &'static str = "m.image"

Available on crate feature events only.

The event type.