romy-core 0.2.0

A runtime for portable, archivable and deterministic video games.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Standard serialization encoding for the project

use byteorder::{LittleEndian, ReadBytesExt};

/// Encodes an object as a series of bytes
/// 
/// # Arguments
/// * `object` - the object to encode
pub fn encode(object: &impl serde::Serialize) -> Vec<u8> {
    bincode::serialize(object).unwrap()
}

/// Encodes an object as a series of bytes, tacking on the size of the data as a u64 at the front
/// 
/// # Arguments
/// * `object` - the object to encode
pub fn encode_with_size(object: &impl serde::Serialize) -> Vec<u8> {
    let mut data = Vec::new();
    let serial = encode(object);
    data.extend((serial.len() as u64).to_le_bytes().iter());
    data.extend(serial.iter());
    data
}

/// Decodes an object from a series of bytes
/// 
/// # Arguments
/// * `data` - the data to decode 
pub fn decode<'a, T: serde::Deserialize<'a>>(data: &'a [u8]) -> T {
    bincode::deserialize(data).unwrap()
}

/// Decodes an object from a series of bytes that has had a size tacked on the front as a u64
/// 
/// # Arguments
/// * `data` - the data to decode 
pub fn decode_with_size<'a, T: serde::Deserialize<'a>>(data: &'a [u8]) -> T {
    decode(&data[8..])
}

/// Decodes an object from a series of bytes given as a pointer that has had a size tacked on the
/// front as a u64
/// 
/// # Arguments
/// * `data` - the data to decode 
pub unsafe fn decode_with_size_ptr<'a, T: serde::Deserialize<'a>>(data: *const u8) -> T {
    let size = std::slice::from_raw_parts(data, 8)
        .read_u64::<LittleEndian>()
        .unwrap();
    let data = std::slice::from_raw_parts(data.offset(8), size as usize);
    decode(&data)
}