Struct MutableArchive 

pub struct MutableArchive { /* private fields */ }

A mutable handle to an MPQ archive that supports modification operations

Implementations

impl MutableArchive

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open an archive for modification

This opens the archive file with read/write permissions and loads the existing archive structure.

Examples

use wow_mpq::MutableArchive;

let mut archive = MutableArchive::open("data.mpq")?;

pub fn archive(&self) -> &Archive

Get immutable access to the underlying archive

This allows reading files and querying archive information while the archive is open for modification.

pub fn archive_mut(&mut self) -> &mut Archive

Get mutable access to the underlying archive

This allows operations that require mutable access such as reading files and listing entries. This is safe because MutableArchive has exclusive ownership of the Archive.

pub fn debug_state(&self) -> (Option<usize>, Option<usize>)

Debug helper to check internal state

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

Read a file from the archive

This method checks the modified state first, then falls back to the original archive. This ensures that renamed files can still be read correctly.

pub fn list(&mut self) -> Result<Vec<FileEntry>>

List files in the archive

This is a convenience method that delegates to the underlying Archive. It allows listing files from a MutableArchive without having to call archive_mut() explicitly.

pub fn find_file(&mut self, name: &str) -> Result<Option<FileInfo>>

Find a file in the archive

This method checks the modified state first, then falls back to the original archive. This ensures that removed/renamed files are handled correctly.

pub fn verify_signature(&mut self) -> Result<SignatureStatus>

Verify the digital signature of the archive

This is a convenience method that delegates to the underlying Archive.

pub fn load_attributes(&mut self) -> Result<()>

Load and cache attributes from the (attributes) file

This is a convenience method that delegates to the underlying Archive.

pub fn add_file<P: AsRef<Path>>( &mut self, source_path: P, archive_name: &str, options: AddFileOptions, ) -> Result<()>

Add a file from disk to the archive

Parameters

• source_path: Path to the file on disk to add
• archive_name: Name for the file within the archive
• options: Options controlling compression, encryption, etc.

Examples

use wow_mpq::{MutableArchive, AddFileOptions};

let mut archive = MutableArchive::open("data.mpq")?;

// Add with default options
archive.add_file("texture.blp", "Textures\\new.blp", Default::default())?;

// Add with custom options
let options = AddFileOptions::new()
    .compression(wow_mpq::compression::CompressionMethod::Lzma)
    .encrypt();
archive.add_file("model.m2", "Models\\character.m2", options)?;

pub fn add_file_data( &mut self, data: &[u8], archive_name: &str, options: AddFileOptions, ) -> Result<()>

Add a file from memory to the archive

Parameters

• data: File data to add
• archive_name: Name for the file within the archive
• options: Options controlling compression, encryption, etc.

pub fn remove_file(&mut self, archive_name: &str) -> Result<()>

Remove a file from the archive

This marks the file as deleted in the hash table. The space is not reclaimed until compact() is called.

Parameters

• archive_name: Name of the file to remove

pub fn rename_file(&mut self, old_name: &str, new_name: &str) -> Result<()>

Rename a file in the archive

Parameters

• old_name: Current name of the file
• new_name: New name for the file

pub fn compact(&mut self) -> Result<()>

Compact the archive to reclaim space from deleted files

This creates a new archive file with all active files copied over, removing any gaps from deleted files.

pub fn flush(&mut self) -> Result<()>

Flush any pending changes to disk

This ensures all modifications are written to the archive file. This is automatically called when the archive is dropped.

Trait Implementations

impl Debug for MutableArchive

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

Formats the value using the given formatter.

impl Drop for MutableArchive

fn drop(&mut self)

Executes the destructor for this type.