Struct ruma_events::room::message::FileMessageEventContent

pub struct FileMessageEventContent {
    pub body: String,
    pub formatted: Option<FormattedBody>,
    pub filename: Option<String>,
    pub source: MediaSource,
    pub info: Option<Box<FileInfo>>,
}

The payload for a file message.

Fields

body: String

A human-readable description of the file.

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.

source: MediaSource

The source of the file.

info: Option<Box<FileInfo>>

Metadata about the file referred to in source.

Implementations

impl FileMessageEventContent

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

Creates a new FileMessageEventContent with the given body and source.

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

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

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

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

pub fn info(self, info: impl Into<Option<Box<FileInfo>>>) -> Self

Creates a new FileMessageEventContent 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.

Trait Implementations

impl Clone for FileMessageEventContent

fn clone(&self) -> FileMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileMessageEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileMessageEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.