Struct SqPackResource

pub struct SqPackResource {
    pub game_directory: String,
    pub repositories: Vec<Repository>,
    /* private fields */
}

Used to read files from the retail game, in their SqPack-compressed format.

Fields

game_directory: String

The game directory to operate on.

repositories: Vec<Repository>

Repositories in the game directory.

Implementations

impl SqPackResource

pub fn from_existing(platform: Platform, directory: &str) -> Self

pub fn find_offset(&mut self, path: &str) -> Option<u64>

Finds the offset inside of the DAT file for path.

pub fn apply_patch(&self, patch_path: &str) -> Result<(), PatchError>

Applies the patch to game data and returns any errors it encounters. This function will not update the version in the GameData struct.

pub fn needs_repair(&self) -> Option<Vec<(&Repository, RepairAction)>>

Detects whether or not the game files need a repair, right now it only checks for invalid version files. If the repair is needed, a list of invalid repositories is given.

pub fn perform_repair<'a>( &self, repositories: &Vec<(&'a Repository, RepairAction)>, ) -> Result<(), RepairError<'a>>

Performs the repair, assuming any damaging effects it may have Returns true only if all actions were taken are successful. NOTE: This is a destructive operation, especially for InvalidVersion errors.

Trait Implementations

impl Resource for SqPackResource

fn read(&mut self, path: &str) -> Option<ByteBuffer>

Reads the file located at path. This is returned as an in-memory buffer, and will usually have to be further parsed.

fn exists(&mut self, path: &str) -> bool

Checks if a file exists While you could abuse read to do this, in some Resources they can optimize this since it doesn’t read data.