Struct OpenOptions 

pub struct OpenOptions {
    pub load_tables: bool,
    /* private fields */
}

Options for opening MPQ archives

This struct provides configuration options for how MPQ archives are opened and initialized. It follows the builder pattern for easy configuration.

Examples

use wow_mpq::{Archive, OpenOptions};

// Open with default options
let archive = Archive::open("data.mpq")?;

// Open with custom options
let archive = OpenOptions::new()
    .load_tables(false)  // Defer table loading for faster startup
    .open("data.mpq")?;

Fields

load_tables: bool

Whether to load and parse all tables immediately when opening the archive.

When true (default), all tables (hash, block, HET/BET) are loaded and validated during archive opening. This provides immediate error detection but slower startup for large archives.

When false, tables are loaded on-demand when first accessed. This provides faster startup but may defer error detection.

Implementations

impl OpenOptions

pub fn new() -> Self

Create new default options

Returns an OpenOptions instance with default settings:

• load_tables = true (immediate table loading)
• version = None (defaults to MPQ v1 for new archives)

pub fn load_tables(self, load: bool) -> Self

Set whether to load tables immediately when opening

Parameters

• load: If true, tables are loaded immediately during open. If false, tables are loaded on first access.

Returns

Self for method chaining

pub fn version(self, version: FormatVersion) -> Self

Set the MPQ version for new archives

This setting only affects archives created with create(), not archives opened with open().

Parameters

• version: The MPQ format version to use (V1, V2, V3, or V4)

Returns

Self for method chaining

pub fn open<P: AsRef<Path>>(self, path: P) -> Result<Archive>

Open an existing MPQ archive with these options

Parameters

• path: Path to the MPQ archive file

Returns

Ok(Archive) on success, Err(Error) on failure

Errors

• Error::Io if the file cannot be opened
• Error::InvalidFormat if the file is not a valid MPQ archive
• Error::Corruption if table validation fails (when load_tables = true)

pub fn create<P: AsRef<Path>>(self, path: P) -> Result<Archive>

Create a new empty MPQ archive with these options

Creates a new MPQ archive file with the specified format version. The archive will be empty but properly formatted.

Parameters

• path: Path where the new archive should be created

Returns

Ok(Archive) on success, Err(Error) on failure

Errors

• Error::Io if the file cannot be created
• Error::InvalidFormat if archive creation fails

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.