Struct MixPackage 

pub struct MixPackage {
    pub game: CncGame,
    pub files: HashMap<String, Vec<u8>>,
}

MIX package

Fields

game: CncGame

The game version of the MIX package

files: HashMap<String, Vec<u8>>

A map of file names to file data

Implementations

impl MixPackage

pub fn load(mix_path: &Path, db: &MixDatabase) -> Result<Self, Ra2Error>

Arguments

• input:

returns: Result<XccPackage, MixError>

Examples

pub fn decode(mix_data: &[u8], db: &MixDatabase) -> Result<Self, Ra2Error>

Reads a MIX file and returns a map of filenames to file data

Arguments

• input:

returns: Result<XccPackage, MixError>

Examples

impl MixPackage

pub fn save(self, output: &Path) -> Result<usize, Ra2Error>

Arguments

• output:

Examples

pub fn dump(self, output: &Path) -> Result<usize, Ra2Error>

pub unsafe fn dump_unchecked(self, output: &Path) -> Result<usize, Ra2Error>

pub fn encode(self) -> Result<Vec<u8>, Ra2Error>

Arguments

• output:

Examples

impl MixPackage

pub fn add_any(&mut self, name: String, data: Vec<u8>)

Add any file to the MIX package, no matter if it is valid or not.

Arguments

• name: the file name with extension
• data: the file bytes

Examples

let mut mix = ra2_mix::MixPackage::default();
mix.add_any("hello.txt".to_string(), b"Hello, World!".to_vec());

pub fn add_file(&mut self, data: &Path) -> Result<usize, Ra2Error>

Add a file from filesystem to the package

Arguments

• data - Path to the file to add

Returns

Size of the added file in bytes on success, or error if file not found

Examples

use ra2_mix::MixPackage;
use std::path::Path;

let mut package = MixPackage::default();
package.add_file(Path::new("test.txt")).unwrap();

Trait Implementations

impl Debug for MixPackage

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

Formats the value using the given formatter.

impl Default for MixPackage

fn default() -> MixPackage

Returns the “default value” for a type.