binary-codec 0.3.2

A binary codec for Rust that provides serialization and deserialization of data structures to and from binary formats.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use crate::{DeserializationError, SerializationError, SerializerConfig, utils::{ensure_size, get_read_size, slice, write_size}};

pub fn read_string<T : Clone>(bytes: &[u8], size_key: Option<&str>, config: &mut SerializerConfig<T>) -> Result<String, DeserializationError> {
    let len = get_read_size(bytes, size_key, config)?;
    config.reset_bits(true);
    let slice = slice(config, bytes, len, true)?;
    let string = String::from_utf8(slice.to_vec()).expect("Not valid UTF-8 bytes to create string");
    
    Ok(string)
}

pub fn write_string<T : Clone>(value: &str, size_key: Option<&str>, buffer: &mut Vec<u8>, config: &mut SerializerConfig<T>) -> Result<(), SerializationError> {
    config.reset_bits(false);
    write_size(value.len(), size_key, buffer, config)?; 

    buffer.extend_from_slice(&value.as_bytes());
    config.pos += value.len();
    Ok(())
}

pub fn read_object<T, U>(bytes: &[u8], size_key: Option<&str>, config: &mut SerializerConfig<U>) -> Result<T, DeserializationError>  
    where T : crate::BinaryDeserializer<U>, U : Clone 
{
    let len = get_read_size(bytes, size_key, config)?;

    // If exact size of buffer is available, don't slice
    if ensure_size(config, bytes, len)? {
        T::deserialize(bytes, Some(config))
    } else {
        // Create an isolated slice like we do for a String, but with its own config
        config.reset_bits(true);
        let mut temp_config = config.clone();
        temp_config.reset();

        let slice = slice(config, bytes, len, true)?;
        T::deserialize(&slice, Some(&mut temp_config))
    }
}

pub fn write_object<T, U>(value: &T, size_key: Option<&str>, buffer: &mut Vec<u8>, config: &mut SerializerConfig<U>) -> Result<(), SerializationError>  
    where T : crate::BinarySerializer<U>, U : Clone
{
    // If length name is provided, we need to ensure the length matches
    // So we write it to a different buffer
    if size_key.is_some() {
        let mut temp_buffer = Vec::new();
        config.reset_bits(false);
        value.write_bytes(&mut temp_buffer, Some(config))?;
        write_size(temp_buffer.len(), size_key, buffer, config)?;
        buffer.extend_from_slice(&temp_buffer);
        Ok(())
    } else {
        value.write_bytes(buffer, Some(config))
    }
}

#[cfg(test)]
mod tests {
    use crate::{BinaryDeserializer, dynamics::read_small_dynamic_unsigned, fixed_int::FixedInt};

    use super::*;

    struct TestObj {
        nr: u16
    }

    impl<T : Clone> BinaryDeserializer<T> for TestObj {
        fn deserialize(bytes: &[u8], config: Option<&mut SerializerConfig<T>>) -> Result<Self, DeserializationError> {
            let config = config.unwrap();
            let nr = FixedInt::read(bytes, config)?;
            Ok(TestObj { nr })
        }
    }

    #[test]
    fn test_read_number_object_after_reading_few_bits() {
        let bytes = vec![0b0000_0011, 0, 7];
        let mut config = SerializerConfig::new(None);

        let small_nr = read_small_dynamic_unsigned(&bytes, &mut config, 2).unwrap();
        assert_eq!(small_nr, 3);
        assert_eq!(config.bits, 2);
        assert_eq!(config.pos, 0);

        let obj = read_object::<TestObj, ()>(&bytes, None, &mut config).unwrap();
        assert_eq!(obj.nr, 7);
        assert_eq!(config.bits, 0);
        assert_eq!(config.pos, 3);
    }
}