Struct ruma_events::room::message::FileMessageEventContent

#[non_exhaustive]
pub struct FileMessageEventContent {
    pub body: String,
    pub filename: Option<String>,
    pub url: Option<MxcUri>,
    pub file: Option<Box<EncryptedFile>>,
    pub info: Option<Box<FileInfo>>,
}

The payload for a file message.

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.

body: String

A human-readable description of the file.

This is recommended to be the filename of the original upload.

filename: Option<String>

The original filename of the uploaded file.

url: Option<MxcUri>

The URL to the file.

file: Option<Box<EncryptedFile>>

Information on the encrypted file.

Required if file is encrypted.

info: Option<Box<FileInfo>>

Metadata about the file referred to in url.

Implementations

impl FileMessageEventContent

pub fn plain(body: String, url: MxcUri, info: Option<Box<FileInfo>>) -> Self

Creates a new non-encrypted FileMessageEventContent with the given body, url and optional extra info.

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

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

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.