Struct matrix_sdk_base::ruma::events::room::message::FileMessageEventContent

#[non_exhaustive]
pub struct FileMessageEventContent {
    pub body: String,
    pub filename: Option<String>,
    pub source: MediaSource,
    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.

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) -> FileMessageEventContent

Creates a new FileMessageEventContent with the given body and source.

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

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

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

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

pub fn filename( self, filename: impl Into<Option<String>> ) -> FileMessageEventContent

Creates a new FileMessageEventContent from self with the filename 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.

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

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D ) -> Result<FileMessageEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MediaEventContent for FileMessageEventContent

fn source(&self) -> Option<MediaSource>

Get the source of the file for Self.

fn thumbnail_source(&self) -> Option<MediaSource>

Get the source of the thumbnail for Self.

impl Serialize for FileMessageEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.