Struct ruma_common::events::room::EncryptedFile

#[non_exhaustive]
pub struct EncryptedFile {
    pub url: OwnedMxcUri,
    pub key: JsonWebKey,
    pub iv: Base64,
    pub hashes: BTreeMap<String, Base64>,
    pub v: String,
}

A file sent to a room with end-to-end encryption enabled.

To create an instance of this type, first create a EncryptedFileInit and convert it via EncryptedFile::from / .into().

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.

key: JsonWebKey

A JSON Web Key object.

iv: Base64

The 128-bit unique counter block used by AES-CTR, encoded as unpadded base64.

hashes: BTreeMap<String, Base64>

A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64.

Clients should support the SHA-256 hash, which uses the key sha256.

v: String

Version of the encrypted attachments protocol.

Must be v2.

Trait Implementations

impl Clone for EncryptedFile

fn clone(&self) -> EncryptedFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncryptedFile

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

Deserialize this value from the given Serde deserializer.

impl From<EncryptedFileInit> for EncryptedFile

fn from(init: EncryptedFileInit) -> Self

Converts to this type from the input type.

impl Serialize for EncryptedFile

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

Serialize this value into the given Serde serializer.