Struct FileContentBlock

#[non_exhaustive]
pub struct FileContentBlock {
    pub url: OwnedMxcUri,
    pub name: String,
    pub mimetype: Option<String>,
    pub size: Option<UInt>,
    pub encryption_info: Option<Box<EncryptedContent>>,
}

Available on crate features events and unstable-msc3551 only.

A block for file content.

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.

url: OwnedMxcUri

The URL to the file.

name: String

The original filename of the uploaded file.

mimetype: Option<String>

The mimetype of the file, e.g. “application/msword”.

size: Option<UInt>

The size of the file in bytes.

encryption_info: Option<Box<EncryptedContent>>

Information on the encrypted file.

Required if the file is encrypted.

Implementations

impl FileContentBlock

pub fn plain(url: OwnedMxcUri, name: String) -> FileContentBlock

Creates a new non-encrypted FileContentBlock with the given url and name.

pub fn encrypted( url: OwnedMxcUri, name: String, encryption_info: EncryptedContent, ) -> FileContentBlock

Creates a new encrypted FileContentBlock with the given url, name and encryption info.

pub fn is_encrypted(&self) -> bool

Whether the file is encrypted.

Trait Implementations

impl Clone for FileContentBlock

fn clone(&self) -> FileContentBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileContentBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileContentBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileContentBlock

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.