Struct SkySave 

pub struct SkySave {
    pub data: Vec<u8>,
    pub active_save_block: ActiveSaveBlock,
    pub quicksave_valid: bool,
    pub general: General,
    pub stored_pokemon: ArrayVec<StoredPokemon, 720>,
    pub active_pokemon: ArrayVec<ActivePokemon, 4>,
}

The main structure of sky-save. Contains the save data bytes and every structure the library parses. Selectively loads data from the active_save_block.

Fields

data: Vec<u8>

active_save_block: ActiveSaveBlock

quicksave_valid: bool

general: General

stored_pokemon: ArrayVec<StoredPokemon, 720>

active_pokemon: ArrayVec<ActivePokemon, 4>

Implementations

impl SkySave

pub fn from_slice<S: AsRef<[u8]>>(data: S) -> Result<Self, SaveError>

Load and validates the save data from a slice of bytes. The save data is validated by checking its length and calculating the checksums. The save file is divided into three blocks: primary, backup, and quicksave. For each block, the first four bytes are the checksum, and it is calculated as follows:

• Convert every four bytes, from start to end, to unsigned 32-bit integers. And then sum them together.
• Truncate the result to a 32-bit integer.
• Convert the result to little-endian bytes.
• Compare with bytes 0 to 3 to check for validity.

After validation, every structure is parsed from the save data.

pub fn open<P: AsRef<Path>>(filename: P) -> Result<Self, SaveError>

Loads save data from a file.

pub fn fix_checksums(&mut self)

Recalculates the checksums for each save block. Writes the checksums to the save data.

pub fn save<P: AsRef<Path>>(&mut self, filename: P) -> Result<(), SaveError>

Saves all changes to data. Recalculates the checksums and writes to a file.

Trait Implementations

impl Debug for SkySave

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

Formats the value using the given formatter.