Struct infinite_rs::ModuleFile

pub struct ModuleFile {
    pub header: ModuleHeader,
    pub files: Vec<ModuleFileEntry>,
    pub string_list: Vec<u8>,
    pub resources: Vec<u32>,
    pub blocks: Vec<ModuleBlockEntry>,
    pub file_data_offset: u64,
    /* private fields */
}

Module structure which contains the layout of the entire module file. Also stores file_path for re-use in read_tag.

Fields

header: ModuleHeader

Info relating to how the other fields should be read.

files: Vec<ModuleFileEntry>

Metadata regarding compression and layout of files (tags)

string_list: Vec<u8>

String slice of file names seperated by a null terminator. Does not exist after module version 52.

resources: Vec<u32>

Indices (?) of resource files present in module.

blocks: Vec<ModuleBlockEntry>

Uncompressed/compressed blocks making up a file.

file_data_offset: u64

Offset in BufReader where file data starts.

Implementations

impl ModuleFile

pub fn new() -> Self

Allocate new ModuleFile and set it to default values.

pub fn read(&mut self, file_path: String) -> Result<()>

Reads the module file from the given file path. This function reads the entire structure of the module file. It also calculates and stores important offsets within the file.

Arguments

• file_path - A string slice that holds the path to the module file

Returns

Returns Ok(()) if the read operation is successful, or an Err containing the I/O error if any reading operation fails/header checks fail.

pub fn read_tag(&mut self, index: usize) -> Result<()>

Reads a specific tag from the module file.

Arguments

• index - The index of the file entry to read the tag from

Returns

Returns Ok(()) if the read operation is successful, or an (anyhow) Error containing the I/O error if any reading operation fails.

pub fn read_tag_from_id(&mut self, global_id: i32) -> Result<Option<usize>>

Searches for the index of the tag given the global_id. Reads the tag using read_tag and stores it in the index.

Arguments

• global_id - The global tag ID of the file to find.

Returns

Returns the index of the file if successful, 0 if it fails. Any I/O Error is also returned if it occurs.

Trait Implementations

impl Debug for ModuleFile

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

Formats the value using the given formatter.

impl Default for ModuleFile

fn default() -> ModuleFile

Returns the “default value” for a type.