Struct unrpa_rs::rpa::RenpyArchive

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

Represents the Renpy archive format

Implementations

impl<'a> RenpyArchive<'a>

pub fn from_file(path: &'a Path) -> Result<Self, RpaError>

Construct a RenpyArchive from a file on the filesystem

This performs I/O operations as it reads the magic literal and the rest of the file to decode the indices present in the archive.

Errors

An error occurs if either an invalid path has been provided to the OS, I/O errors occurs during reading the file, the zlib decoding fails, or the serde deserialization process fails.

Panics

This function panics if it either encounters an unsupported RpaVersion, i.e. a variant not covered in the enum declaration, or the integer parsing while constructing the obfuscation key fails.

pub fn indices_map(&self) -> &RpaIdxColl

Method to get access to the collection data structure of RpaIdx

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

Lists all the files present in one archive

pub fn path(&self) -> &Path

pub fn extract_files_from_indices(
    &mut self,
    extract_behaviour: DirExtractBehaviour
) -> Result<(), RpaError>

Extracts all files from the indices and writes them to disk

pub fn read_file_from_archive(
    &mut self,
    filename: &str
) -> Result<Vec<u8>, RpaError>

Reads the byte buffer of the specified file in the archive into memory

pub fn write_file(
    &mut self,
    filepath: &Path,
    file_buf: &[u8]
) -> Result<(), RpaError>

Writes the byte buffer of one file to disk

pub fn estimate_overall_write_speed(&self) -> f32

Calculates an estimation of the overall write speed, in MB/s.

pub fn total_bytes_written(&self) -> usize

Returns the total amount of bytes written to disk

pub fn total_bytes_written_duration(&self) -> &Duration

Returns the duration it took to write all bytes to disk

Trait Implementations

impl<'a> Debug for RenpyArchive<'a>

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

Formats the value using the given formatter.