Struct ceres_mpq::Archive

pub struct Archive<R: Read + Seek> { /* fields omitted */ }

Implementation of a MoPaQ archive viewer.

Refer to top-level documentation to see which features are supported.

Will work on any reader that implements Read + Seek.

Methods

impl<R: Read + Seek> Archive<R>

pub fn open(reader: R) -> Result<Archive<R>, Error>

Try to open an MPQ archive from the specified reader.

Immediately, this will perform the following:

1. Locate an MPQ header.
2. Locate and read the Hash Table.
3. Locate and read the Block Table.

If any of these steps fail, the archive is deemed corrupted and an appropriate error is returned.

No other operations will be performed.

pub fn read_file(&mut self, name: &str) -> Result<Vec<u8>, Error>

Read a file's contents.

Notably, the filename resolution algorithm is case-insensitive, and will treat backslashes (\) and forward slashes (/) as the same character.

Does not support single-unit files or uncompressed files.

pub fn files(&mut self) -> Option<Vec<String>>

If the archive contains a (listfile), this will method parse it and return a Vec containing all known filenames.

pub fn start(&self) -> u64

pub fn end(&self) -> u64

pub fn size(&self) -> u64

pub fn reader(&mut self) -> &mut R

Trait Implementations

impl<R: Debug + Read + Seek> Debug for Archive<R>

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

Formats the value using the given formatter.