Struct savefile::Deserializer

pub struct Deserializer<'a> {
    pub file_version: u32,
    pub memory_version: u32,
    // some fields omitted
}

Object from which bytes to be deserialized are read. This is basically just a wrapped std::io::Read object, the version number of the file being read, and the current version number of the data structures in memory.

Fields

file_version: u32

The version of the input file

memory_version: u32

The version of the data structures in memory

Implementations

impl<'a> Deserializer<'a>

pub fn get_state<T: 'static, R: Default + 'static>(&mut self) -> &mut R

This function constructs a temporary state object of type R, and returns a mutable reference to it. This object can be used to store data that needs to live for the entire deserialization session. An example is de-duplicating Arc and other reference counted objects. Out of the box, Arc has this deduplication done for it. The type T must be set to the type being deserialized, and is used as a key in a hashmap separating the state for different types.

impl<'a> Deserializer<'a>

pub fn read_bool(&mut self) -> Result<bool, SavefileError>

Reads a u8 and return true if equal to 1

pub fn read_u8(&mut self) -> Result<u8, SavefileError>

Reads an u8

pub fn read_u16(&mut self) -> Result<u16, SavefileError>

Reads a little endian u16

pub fn read_u32(&mut self) -> Result<u32, SavefileError>

Reads a little endian u32

pub fn read_u64(&mut self) -> Result<u64, SavefileError>

Reads a little endian u64

pub fn read_i8(&mut self) -> Result<i8, SavefileError>

Reads an i8

pub fn read_i16(&mut self) -> Result<i16, SavefileError>

Reads a little endian i16

pub fn read_i32(&mut self) -> Result<i32, SavefileError>

Reads a little endian i32

pub fn read_i64(&mut self) -> Result<i64, SavefileError>

Reads a little endian i64

pub fn read_f32(&mut self) -> Result<f32, SavefileError>

Reads a little endian f32

pub fn read_f64(&mut self) -> Result<f64, SavefileError>

Reads a little endian f64

pub fn read_isize(&mut self) -> Result<isize, SavefileError>

Reads an i64 into an isize. For 32 bit architectures, the function fails on overflow.

pub fn read_usize(&mut self) -> Result<usize, SavefileError>

Reads an u64 into an usize. For 32 bit architectures, the function fails on overflow.

pub fn read_string(&mut self) -> Result<String, SavefileError>

Reads a 64 bit length followed by an utf8 encoded string. Fails if data is not valid utf8

pub fn read_bytes(&mut self, len: usize) -> Result<Vec<u8>, SavefileError>

Reads ‘len’ raw u8 bytes as a Vec

pub fn read_bytes_to_buf(&mut self, buf: &mut [u8]) -> Result<(), SavefileError>

Reads raw u8 bytes into the given buffer. The buffer size must be equal to the number of bytes desired to be read.

pub fn load<T: WithSchema + Deserialize>(
    reader: &mut dyn Read,
    version: u32
) -> Result<T, SavefileError>

Deserialize an object of type T from the given reader. Don’t use this method directly, use the crate::load function instead.

pub fn load_noschema<T: WithSchema + Deserialize>(
    reader: &mut dyn Read,
    version: u32
) -> Result<T, SavefileError>

Deserialize an object of type T from the given reader. Don’t use this method directly, use the crate::load_noschema function instead.

pub fn new_raw(reader: &mut dyn Read) -> Deserializer<'_>

Create a Deserializer. Don’t use this method directly, use the crate::load function instead.