Struct ruma_events::file::FileEventContent

pub struct FileEventContent {
    pub text: TextContentBlock,
    pub file: FileContentBlock,
    pub caption: Option<CaptionContentBlock>,
    pub automated: bool,
    pub relates_to: Option<Relation<FileEventContentWithoutRelation>>,
}

The payload for an extensible file message.

This is the new primary type introduced in MSC3551 and should only be sent in rooms with a version that supports it. See the documentation of the message module for more information.

Fields

text: TextContentBlock

The text representation of the message.

file: FileContentBlock

The file content of the message.

caption: Option<CaptionContentBlock>

The caption of the message, if any.

automated: bool

Whether this message is automated.

relates_to: Option<Relation<FileEventContentWithoutRelation>>

Information about related messages.

Implementations

impl FileEventContent

pub fn plain(text: TextContentBlock, url: OwnedMxcUri, name: String) -> Self

Creates a new non-encrypted FileEventContent with the given fallback representation, url and file info.

pub fn plain_with_plain_text( plain_text: impl Into<String>, url: OwnedMxcUri, name: String, ) -> Self

Creates a new non-encrypted FileEventContent with the given plain text fallback representation, url and name.

pub fn encrypted( text: TextContentBlock, url: OwnedMxcUri, name: String, encryption_info: EncryptedContent, ) -> Self

Creates a new encrypted FileEventContent with the given fallback representation, url, name and encryption info.

pub fn encrypted_with_plain_text( plain_text: impl Into<String>, url: OwnedMxcUri, name: String, encryption_info: EncryptedContent, ) -> Self

Creates a new encrypted FileEventContent with the given plain text fallback representation, url, name and encryption info.

Trait Implementations

impl Clone for FileEventContent

fn clone(&self) -> FileEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for FileEventContent

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<FileEventContent> for AnyMessageLikeEventContent

fn from(c: FileEventContent) -> Self

Converts to this type from the input type.

impl From<FileEventContent> for FileEventContentWithoutRelation

fn from(c: FileEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for FileEventContent

type Redacted = RedactedFileEventContent

The redacted form of the event’s content.

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

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

impl Serialize for FileEventContent

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 FileEventContent

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

The event type.

impl MessageLikeEventContent for FileEventContent