Struct FileHeader 

pub struct FileHeader { /* private fields */ }

Validated cleartext header. It is authenticated by every file chunk.

Implementations

impl FileHeader

pub fn new(size: u64) -> Self

Describe a file of this plaintext size, in fixed 64-KiB chunks.

pub fn decode(bytes: &[u8]) -> Result<Self, Error>

Decode exactly the 11-byte header, without reading any ciphertext.

pub fn encode(&self) -> [u8; 11]

Encode kind, version and size, all integers big-endian.

pub fn size(&self) -> u64

The file’s complete plaintext size.

pub fn chunk_count(&self) -> u64

How many chunks follow this header; an empty file has none.

pub fn encrypted_size(&self) -> Result<u64, Error>

Full stored size, refusing an offset that cannot be represented in u64.

pub fn chunk(&self, index: u64) -> Result<FileChunk, Error>

The exact storage offset and plaintext length of a particular chunk.

pub fn chunk_at(&self, position: u64) -> Result<FileChunk, Error>

The chunk whose stored bytes hold the object’s byte position; a position in the header or past the last chunk has none.

pub fn seal_chunk( &self, key: &FileKey, path: &str, index: u64, plaintext: &[u8], ) -> Result<Vec<u8>, FileError>

Validate a chunk’s plaintext length, then seal it under the file’s key.

pub fn open_chunk( &self, key: &FileKey, path: &str, index: u64, bytes: &[u8], ) -> Result<Vec<u8>, FileError>

Validate a chunk’s stored length before authenticating or allocating.

Trait Implementations

impl Clone for FileHeader

fn clone(&self) -> FileHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileHeader

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

Formats the value using the given formatter.

impl PartialEq for FileHeader

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

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

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 Copy for FileHeader

impl Eq for FileHeader

impl StructuralPartialEq for FileHeader