binary-codec 0.6.7

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

pub mod reader;
pub mod writer;

/// Crypto Stream
pub trait CryptoStream {
    /// Applies the keystream byte to the given byte and returns the result.
    fn apply_keystream_byte(&mut self, b: u8) -> u8;

    /// Applies the keystream to the given slice and returns the result.
    fn apply_keystream(&mut self, slice: &[u8]) -> &[u8];

    /// Get the underlying original/encrypted buffer
    /// `original` indicates whether to return the original (unencrypted) buffer or the encrypted buffer.
    fn get_cached(&self, original: bool) -> &[u8];

    /// Extend the internal state of this crypto stream with another's.
    fn replace(&mut self, other: &Box<dyn CryptoStream>);

    /// Set internal cache for this crypto stream
    fn set_cached(&mut self, data: &[u8]);
}

#[cfg(test)]
mod tests {
    use crate::bitstream::{reader::BitStreamReader, writer::BitStreamWriter};

    #[test]
    fn can_serialize_and_deserialize_using_bitstream() {
        let mut buffer = Vec::new();
        let mut writer = BitStreamWriter::new(&mut buffer);

        writer.write_bit(true);
        writer.write_bit(false);
        writer.write_bit(true);
        writer.write_byte(12);
        writer.write_bytes(&[34, 56]);

        assert_eq!(writer.byte_pos(), 4);

        let mut reader = BitStreamReader::new(&buffer);
        assert_eq!(reader.read_bit().unwrap(), true);
        assert_eq!(reader.read_bit().unwrap(), false);
        assert_eq!(reader.read_bit().unwrap(), true);
        assert_eq!(reader.read_byte().unwrap(), 12);
        assert_eq!(reader.read_byte().unwrap(), 34);
        assert_eq!(reader.read_byte().unwrap(), 56);

        assert_eq!(buffer, [0b00000101, 12, 34, 56]);
    }
}