Struct MPQBuilder 

pub struct MPQBuilder {
    pub archive_header: Option<MPQFileHeader>,
    pub user_data: Option<MPQUserData>,
    pub hash_table_entries: Vec<MPQHashTableEntry>,
    pub block_table_entries: Vec<MPQBlockTableEntry>,
    pub encryption_table: HashMap<u32, u32>,
}

A builder for the MPQ parsing, allowing for building the archive progressively

Fields

archive_header: Option<MPQFileHeader>

Mandatory field, all MPQ Archives must have an archive header.

user_data: Option<MPQUserData>

Optional field, not all MPQ Archives have user_data. The user_data contains in the case of Starcrat 2 Replay file, the build information of the version of the game under whcich is played. Different game versions would become different protocols/details, maybe even units?

hash_table_entries: Vec<MPQHashTableEntry>

The MPQ Hash Table Entries content.

block_table_entries: Vec<MPQBlockTableEntry>

The MPQ Block Table Entries content

encryption_table: HashMap<u32, u32>

An encryption table to lookup, this is shared with the crate::MPQ object itself.

Implementations

impl MPQBuilder

pub fn new() -> Self

Initializes the Builder, internally creates the encryption table.

pub fn with_archive_header(self, archive_header: MPQFileHeader) -> Self

Sets the archive header field

pub fn with_user_data(self, user_data: Option<MPQUserData>) -> Self

Sets the user data field

pub fn with_hash_table(self, entries: Vec<MPQHashTableEntry>) -> Self

Sets the hash table entries

pub fn with_block_table(self, entries: Vec<MPQBlockTableEntry>) -> Self

Sets the block table entries

pub fn mpq_string_hash( &self, location: &str, hash_type: MPQHashType, ) -> Result<u32, MPQParserError>

Performs mpq string hashing using the encryption table.

pub fn mpq_data_decrypt<'a>( &'a self, data: &'a [u8], key: u32, ) -> MPQResult<&'a [u8], Vec<u8>>

Uses the encryption table and key to decrypt some bytes

pub fn build(self, _orig_input: &[u8]) -> Result<MPQ, MPQParserError>

Consumes self and turns into the final MPQ.

Trait Implementations

impl Debug for MPQBuilder

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

Formats the value using the given formatter.

impl Default for MPQBuilder

fn default() -> Self

Returns the “default value” for a type.