Struct ModuleHeader

pub struct ModuleHeader {

    magic: u32,
    pub version: ModuleVersion,
    pub module_id: i64,
    pub file_count: u32,
    loadmanifest_index: i32,
    runtimeloadmetadata_index: i32,
    resourcemetadata_index: i32,
    resource_index: i32,
    strings_size: u32,
    pub(super) resource_count: u32,
    pub(super) block_count: u32,
    build_version: u64,
    pub(super) hd1_delta: u64,
    pub(super) data_size: u64,
}

Module Header structure containing info on the layout of the module file.

Fields

magic: u32

Should be “mohd” (0x64686F6D)

version: ModuleVersion

Revision number of the module. This determines how offsets are calculated and if tag names should be read.

module_id: i64

Unique identifier of module.

file_count: u32

Number of files in the module.

loadmanifest_index: i32

Index of loadmanifest tag, which contains the tag ids that the module will load.

runtimeloadmetadata_index: i32

Index of runtimeloadmetadata tag, which contains info on how tags should be loaded at runtime.

resourcemetadata_index: i32

Index of resourcemetadata tag, which contains info on how resources should be loaded.

resource_index: i32

Index of the first resource entry (file_count - resource_count).

strings_size: u32

Total size in bytes of the string table.

resource_count: u32

Number of resource files.

block_count: u32

Number of data blocks.

build_version: u64

Same between modules, changes per build?

hd1_delta: u64

If non-zero, requires hd1 file.

data_size: u64

Total size of packed data in the module. Both compressed and uncompressed. Starts after files, blocks, and resources have been read.

This does NOT apply for versions before ModuleVersion::Season3.

Implementations

impl ModuleHeader

pub(super) fn read(&mut self, reader: &mut BufReader<File>) -> Result<()>

Reads the module header from the given buffered reader.

Arguments

• reader - A mutable reference to a BufReader<File> from which to read the data.

Errors

• If the magic number is not equal to HEADER_MAGIC ModuleError::IncorrectMagic
• If the version number is not recognized ModuleError::IncorrectVersion
• If the reader fails to read the exact number of bytes ReadError

Trait Implementations

impl Debug for ModuleHeader

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

Formats the value using the given formatter.

impl Default for ModuleHeader

fn default() -> ModuleHeader

Returns the “default value” for a type.