Struct SaveFile

pub struct SaveFile {
    contents: Vec<u8>,
    binary: bool,
}

A struct that represents a ck3 save file. It is just a wrapper around the contents of the save file. This is so that we can abstract away the compression, encoding and just return an abstract Tape that can be used to read from the save file.

Fields

contents: Vec<u8>

The contents of the save file, shared between all sections

binary: bool

Implementations

impl<'a> SaveFile

pub fn open<P: AsRef<Path>>(filename: P) -> Result<SaveFile, SaveFileError>

Open a save file. Internally uses File::open to open the file and then SaveFile::read to read the contents.

pub fn read<F: Read>( file: &mut F, contents_size: Option<usize>, ) -> Result<SaveFile, SaveFileError>

Create a new SaveFile instance.

Compression

The save file can be compressed using the zip format. Function will automatically detect if the save file is compressed and decompress it.

Returns

A new SaveFile instance. It is an iterator that returns sections from the save file.

pub fn tape(&'a self) -> Tape<'a>

Get the tape from the save file.