Struct Decrypter

pub struct Decrypter<'a> { /* private fields */ }

A struct responsible for decrypting and extracting files from encrypted game archives.

Implementations

impl<'a> Decrypter<'a>

pub fn new() -> Self

Creates a new Decrypter with empty buffer, and force set to false.

pub fn force(self, enabled: bool) -> Self

Enables or disables forced overwrite during extraction.

When enabled is true, extracted files will overwrite existing files on disk.

Returns self.

pub fn set_force(&mut self, enabled: bool)

Enables or disables forced overwrite during extraction.

When enabled is true, extracted files will overwrite existing files on disk.

pub fn extract<P: AsRef<Path>>( &mut self, data: &[u8], output_path: P, ) -> Result<ExtractOutcome, ExtractError>

Extracts files from the archive data into the specified output path.

Parameters

• data: The content of the archive file.
• output_path: The output path for extracted files.

Returns

• Ok(ExtractOutcome::Extracted) if files were successfully extracted.
• Ok(ExtractOutcome::FilesExist) if files already exist and force is false.
• Err(ExtractError::InvalidHeader) for invalid header.
• Err(ExtractError::InvalidEngine) for invalid header engine type byte.

Example

use rpgmad_lib::Decrypter;

let archive_data: Vec<u8> = std::fs::read("Game.rgss3a").unwrap();
let mut decrypter = Decrypter::new();
decrypter.extract(&archive_data, "output").unwrap();

Trait Implementations

impl<'a> Default for Decrypter<'a>

fn default() -> Self

Returns a new Decrypter with default parameters.

Equivalent to calling Decrypter::new().