Struct FileHeader 

pub struct FileHeader {
    pub magic: [u8; 8],
    pub format_type: FormatType,
    pub version: FormatVersion,
    pub feature_flags: u32,
    pub reserved: [u8; 15],
}

File header with magic and version

Fields

magic: [u8; 8]

Magic bytes (8)

format_type: FormatType

Format type (1 byte)

version: FormatVersion

Format version (4 bytes)

feature_flags: u32

Feature flags (4 bytes)

reserved: [u8; 15]

Reserved for future use (15 bytes)

Implementations

impl FileHeader

pub const SIZE: usize = 32

Header size in bytes

pub fn new(format_type: FormatType, version: FormatVersion) -> Self

Create a new header for a format type

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

Serialize to bytes

pub fn from_bytes(buf: &[u8]) -> Result<Self, VersionError>

Parse from bytes

pub fn check_compatibility( &self, expected_type: FormatType, current_version: FormatVersion, ) -> Result<CompatibilityResult, VersionError>

Check compatibility with expected type and version

pub fn validate( bytes: &[u8], expected_type: FormatType, current_version: FormatVersion, ) -> Result<(Self, CompatibilityResult), SochDBError>

Parse and validate a file header in a single fail-fast step.

This is the canonical entry point for opening any persisted SochDB file that uses the unified FileHeader contract. It guarantees that:

1. The magic bytes match SOCHDB_MAGIC (else the file is not a SochDB file, or is truncated/corrupt).
2. The on-disk FormatType matches what the caller expects (else the caller is reading the wrong kind of file).
3. The on-disk version is compatible with current_version (else the file was written by an incompatible — usually newer — release).

Unlike from_bytes + [check_compatibility], any failure here is mapped to SochDBError::Corruption so callers across the workspace can propagate a single, clear, fail-fast error instead of silently misinterpreting bytes. A CompatibilityResult::NeedsMigration outcome is returned as Ok so callers can run the migration pipeline; an outright incompatible version is an error.

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.