Enum FileHeader 

#[non_exhaustive]
pub enum FileHeader {
    V2(FileHeaderV2),
    V3(FileHeaderV3),
}

FHDR chunk: patch file header with a version-specific body.

This is always the first chunk in a well-formed ZiPatch file, immediately following the 12-byte file magic. The version byte selects whether a v2 or v3 body follows.

Wire format

[version_word: i32 LE]   -- version = bits 16..23 of this word
[body: version-specific] -- FileHeaderV2 or FileHeaderV3 (big-endian)
[trailing: 0x08 or 0xB8 bytes of zeros/unknowns, ignored]

The version word is the only little-endian field in the chunk. The rest of the header is big-endian, matching the rest of the format.

Errors

Parsing fails with crate::ZiPatchError::BinrwError if the body is too short to contain the full version-specific fields.

See lib/FFXIVQuickLauncher/.../Chunk/FileHeaderChunk.cs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V2(FileHeaderV2)

Version 2 header — older patches with minimal metadata.

V3(FileHeaderV3)

Version 3 header — modern patches with full statistical summary.

Implementations

impl FileHeader

pub fn version(&self) -> u8

Returns the format version number: 2 for FileHeader::V2, 3 for FileHeader::V3.

pub fn patch_type(&self) -> &[u8; 4]

Returns the 4-byte ASCII patch type tag (e.g. b"D000" or b"H000").

Delegates to the inner FileHeaderV2::patch_type or FileHeaderV3::patch_type field without copying.

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

impl StructuralPartialEq for FileHeader