Struct ParsedFile 

pub struct ParsedFile(Inner);

A parsed shadow file of any format version.

Tuple Fields

0: Inner

Implementations

impl ParsedFile

pub fn parse(bytes: &[u8]) -> Result<ParsedFile, HeaderError>

Parses a serialized shadow file, dispatching on its version byte.

Accepts both complete files and header-only prefixes (at least the full header must be present); trailing bytes are treated as content ciphertext. When parsing a header-only prefix, use ParsedFile::content_decryptor and feed the content bytes externally — ParsedFile::decrypt needs the complete file.

pub fn version(&self) -> Version

pub fn algorithm(&self) -> Algorithm

The AEAD algorithm this file’s format version uses.

pub fn header_length(&self) -> usize

Total length of the file’s serialized header; the content ciphertext starts at this offset.

pub fn kdf_request(&self) -> KdfRequest

The key derivation inputs recorded in the file’s header. Untrusted: validate against resource bounds before calling ParsedFile::derive_key.

pub fn derive_key( &self, password: &[u8], ) -> Result<(SecureKey, KeyDerivationReport), KeyDerivationError>

Derives the file’s encryption key from a password, using the KDF and parameters of the file’s own format version.

pub fn decrypt(&self, key: &SecureKey) -> Result<PlaintextFile, FileError>

Decrypts the file’s filename and content. Requires the file to have been parsed from its complete bytes; for streamed decryption use ParsedFile::content_decryptor.

pub fn decrypt_filename( &self, key: &SecureKey, ) -> Result<SecureString, FileError>

Decrypts only the original filename stored in the file’s header.

pub fn decrypt_metadata( &self, key: &SecureKey, ) -> Result<FileMetadata, FileError>

Decrypts the file’s metadata stored in the header. Format versions that predate metadata storage (v1, v2) return only the filename.

pub fn content_decryptor(&self, key: &SecureKey) -> ContentDecryptor<'_>

Starts decrypting the file’s content from externally supplied ciphertext bytes (starting at ParsedFile::header_length), so the caller controls I/O and memory. Works uniformly across versions: ContentDecryptor::chunk_len says how to feed the bytes.