Enum ffsend_api::file::metadata::Metadata

pub enum Metadata {
    V2 {
        name: String,
        iv: String,
        mime: String,
    },
    V3 {
        name: String,
        mime: String,
        size: u64,
        manifest: Manifest,
    },
}

File metadata, which is send to the server.

Variants

V2

Metadata using in Send v2.

Fields of V2

name: String

The file name.

iv: String

The input vector.

mime: String

The file mimetype. TODO: can we use the Mime type here?

V3

Metadata using in Send v3.

Fields of V3

name: String

The file name.

mime: String

The file mimetype. TODO: can we use the Mime type here?

size: u64

The file size.

manifest: Manifest

The share manifest.

Methods

impl Metadata

pub fn from_send2(iv: &[u8], name: String, mime: &Mime) -> Self

Construct metadata from the given properties.

Parameters:

• iv: initialisation vector
• name: file name
• mime: file mimetype

pub fn from_send3(name: String, mime: String, size: u64) -> Self

Construct metadata from the given properties.

Parameters:

• name: file name
• mime: file mimetype
• size: file size

pub fn to_json(&self) -> String

Convert this structure to a JSON string.

pub fn name(&self) -> &str

Get the file name.

pub fn mime(&self) -> &str

Get the file MIME type.

pub fn iv(&self) -> Option<[u8; 12]>

Get the input vector if set.

For Firefox Send v3 and above None is returned as no input vector is used.

pub fn size(&self) -> Option<u64>

Get the file size if set (>= Send v3).

pub fn is_archive(&self) -> bool

Check whether this MIME type is recognized as supported archive type. true is returned if it's an archive, false if not.

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Serialize for Metadata

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Metadata

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

Deserialize this value from the given Serde deserializer.