Struct FileHeader 

pub struct FileHeader { /* private fields */ }

Fixed-size file header stored at the beginning of every encrypted file.

The layout is #[repr(C)] with all fields being u8 or [u8; N], so:

• Alignment = 1 (same as u8)
• Size = exactly HEADER_LEN (64 bytes)
• No padding — the compiler cannot insert any between u8-aligned fields

This makes zero-copy casting to/from [u8; HEADER_LEN] sound, verified by the compile-time assertions below.

Implementations

impl FileHeader

pub const fn new(compressed: bool, salt: [u8; 16], file_id: [u8; 16]) -> Self

Construct a header with explicit file_id. Callers are responsible for generating (or looking up the cached) file_id so that re-encryption is deterministic.

pub fn generate_file_id() -> [u8; 16]

Generate a fresh random file_id using the system RNG.

pub fn from_bytes(bytes: &[u8; 64]) -> Result<&Self>

Zero-copy: validate and cast &[u8; 64] → &FileHeader.

The returned reference borrows from bytes — no allocation or copying.

pub fn read_from<R: Read>(reader: &mut R) -> Result<Self>

Read 64 bytes from reader, validate, and return an owned header.

This is a convenience wrapper around from_bytes for callers that already have a Read impl (e.g. integration tests).

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Write the header bytes to writer (zero-copy via [as_bytes]).

pub const fn as_bytes(&self) -> &[u8; 64]

Zero-copy: view the header as a fixed-size byte slice.

The returned &[u8; HEADER_LEN] borrows from self.

pub const fn is_compressed(&self) -> bool

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

impl Debug for FileHeader

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

Formats the value using the given formatter.

impl Eq for FileHeader

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