Struct Storage 

pub struct Storage { /* private fields */ }

RAII wrapper for MPQ archive access

Provides full CRUD operations on MPQ archives. Modifications are held in a virtual overlay until save() is called, which writes a complete new archive atomically (write to temp file, then rename).

All public methods are thread-safe: read operations acquire a shared lock; write and persist operations acquire an exclusive lock.

Implementations

impl Storage

pub fn open(path: &str, pool: Option<&HostWorkerPool>) -> Option<Storage>

Open an existing MPQ archive. Memory-maps the file and parses tables. @param path Path to the .mpq file. @param pool Optional WorkerPool for parallel compress/decompress (non-owning). @return A valid Storage, or std::nullopt on failure.

pub fn create( opts: &CreateOptions, pool: Option<&HostWorkerPool>, ) -> Option<Storage>

Create a new empty archive in memory. No file on disk until save(path).

pub fn close(&mut self)

Release all resources. Same effect as letting the Storage go out of scope.

pub fn read_file(&self, name: &str) -> Option<Bytes>

Read a file from the archive. Checks the overlay first, then the source archive. @return File contents, or std::nullopt if not found or deleted.

pub fn read_file_name_locale(&self, name: &str, locale: u16) -> Option<Bytes>

Read a file with a specific locale.

pub fn file_exists(&self, name: &str) -> bool

Check if a file exists in the archive (including overlay).

pub fn file_info(&self, name: &str) -> Option<FileInfo>

Get information about a file.

pub fn archive_info(&self) -> Option<ArchiveInfo>

Get summary information about the archive.

pub fn list_files(&self) -> Vec<String>

List all known filenames (from listfile + overlay additions − deletions).

pub fn write_file( &mut self, name: &[u8], data: &[u8], opts: &WriteOptions, ) -> bool

Write or overwrite a file. Data is held in overlay until save(). @return true on success, false if the hash table is full.

pub fn delete_file(&mut self, name: &str) -> bool

Delete a file from the archive. @return true if the file was found (in source or overlay), false otherwise.

pub fn save(&mut self) -> bool

Save the archive to its original path (temp file + atomic rename). @return false if this Storage was created via create() with no prior save(path).

pub fn save_path(&mut self, path: &str) -> bool

Save the archive to a specific path. After saving, the new file becomes the source archive and the overlay is cleared.

Trait Implementations

impl Debug for Storage

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

Formats the value using the given formatter.

impl Drop for Storage

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Storage