Enum FileContent

pub enum FileContent {
    Embedded {
        name: String,
        mime: String,
        buffer: SecretBox<Vec<u8>>,
        checksum: [u8; 32],
    },
    External {
        name: String,
        mime: String,
        checksum: [u8; 32],
        size: u64,
        path: Option<PathBuf>,
    },
}

Variants for embedded and external file secrets.

Variants

Embedded

Embedded file buffer.

Fields

name: String

File name.

mime: String

Mime type for the data.

Use application/octet-stream if no mime-type is available.

buffer: SecretBox<Vec<u8>>

The binary data.

checksum: [u8; 32]

The SHA-256 digest of the buffer.

Using the SHA-256 digest allows the checksum to be computed using the Javascript SubtleCrypto API and in Dart using the crypto package.

This is used primarily during the public migration export to identify files that have been extracted to another location in the archive rather than embedding the binary data.

External

Encrypted data is stored in an external file.

Fields

name: String

File name.

mime: String

Mime type for the data.

Use application/octet-stream if no mime-type is available.

checksum: [u8; 32]

The SHA-256 digest of the buffer.

Using the SHA-256 digest allows the checksum to be computed using the Javascript SubtleCrypto API and in Dart using the crypto package.

This is used primarily during the public migration export to identify files that have been extracted to another location in the archive rather than embedding the binary data.

size: u64

Size of the encrypted file content.

path: Option<PathBuf>

Optional path to a source file; never encoded or serialized.

Implementations

impl FileContent

pub fn name(&self) -> &str

File name.

pub fn mime(&self) -> &str

File mime type.

pub fn checksum(&self) -> &[u8; 32]

File checksum.

pub fn size(&self) -> u64

File size.

Trait Implementations

impl Clone for FileContent

fn clone(&self) -> FileContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Decodable for FileContent

fn decode<'life0, 'life1, 'async_trait, R>( &'life0 mut self, reader: &'life1 mut BinaryReader<R>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, R: 'async_trait + AsyncRead + AsyncSeek + Unpin + Send, FileContent: 'async_trait,

Decode from the binary reader into self.

impl Default for FileContent

fn default() -> FileContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for FileContent

fn encode<'life0, 'life1, 'async_trait, W>( &'life0 self, writer: &'life1 mut BinaryWriter<W>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, W: 'async_trait + AsyncWrite + AsyncSeek + Unpin + Send, FileContent: 'async_trait,

Encode self into the binary writer.

impl PartialEq for FileContent

fn eq(&self, other: &FileContent) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FileContent

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.