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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
#![feature(test)]

use bitvec::field::BitField;
use bitvec::order::BitOrder;
use bitvec::slice::BitSlice;
use bitvec::store::BitStore;
use bitvec::vec::BitVec;
use serde::{Deserialize, Serialize};

pub use container::{BitContainer, ContainerSize};
pub use error::{Error, Result};

pub use crate::encoding::{BinaryEncoding, EndianEncoding};

mod container;
mod de;
mod encoding;
mod error;
mod ser;

pub fn deserialize<'a, T: Deserialize<'a>, O: BitOrder, S: BitStore, E: BinaryEncoding>(
    bits: &'a BitSlice<O, S>,
) -> Result<(T, usize)>
where
    BitSlice<O, S>: BitField,
{
    let mut deserializer = de::BitDeserializer::<'_, O, S, E>::new(bits);
    Ok((T::deserialize(&mut deserializer)?, deserializer.offset))
}

pub fn serialize<T: Serialize, O: BitOrder + 'static, S: BitStore, E: BinaryEncoding>(
    value: &T,
) -> Result<BitVec<O, S>>
where
    BitSlice<O, S::Alias>: BitField,
{
    let mut serializer = ser::BitSerializer::<O, S, E> {
        vec: BitVec::new(), //todo we can reduce allocation costs by pre-allocating with struct bit size ~35 ns
        endian: Default::default(),
    };
    value.serialize(&mut serializer)?;
    Ok(serializer.vec.clone())
}

#[cfg(test)]
mod tests {
    extern crate test;

    use test::Bencher;

    use bitvec::order::Lsb0;
    use bitvec::view::BitView;
    use serde::{Deserialize, Serialize};

    use crate::encoding::EndianEncoding;
    use crate::{deserialize, serialize, BitContainer, ContainerSize};

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct BitTest(bool, bool, bool, bool, bool, bool, bool, bool);

    #[test]
    fn bit() {
        let data = vec![0x23u8];
        let (obj, _) = deserialize::<BitTest, _, _, EndianEncoding>(data.view_bits::<Lsb0>()).unwrap();
        assert_eq!(
            obj,
            BitTest(true, true, false, false, false, true, false, false)
        );
        assert_eq!(
            serialize::<_, Lsb0, u8, EndianEncoding>(&obj).unwrap(),
            data.view_bits::<Lsb0>().to_bitvec()
        );
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct ByteTest(u8, u8, u8);

    #[test]
    fn bytes() {
        let data = vec![0x01u8, 0x02, 0x03];
        let (obj, _) = deserialize::<ByteTest, _, _, EndianEncoding>(data.view_bits::<Lsb0>()).unwrap();
        assert_eq!(obj, ByteTest(0x01, 0x02, 0x03));
        assert_eq!(
            serialize::<_, Lsb0, u8, EndianEncoding>(&obj).unwrap(),
            data.view_bits::<Lsb0>().to_bitvec()
        );
    }

    #[derive(Debug, PartialEq)]
    struct BitsSize;
    impl ContainerSize for BitsSize {
        fn size() -> usize {
            7
        }
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct BitsTest(BitContainer<BitsSize, Lsb0, u8>, bool, u8);

    #[test]
    fn bits() {
        let data = vec![0x23u8, 0x01];
        let (obj, _) = deserialize::<BitsTest, _, _, EndianEncoding>(data.view_bits::<Lsb0>()).unwrap();
        assert_eq!(obj.0.as_byte().unwrap(), 0x23);
        assert_eq!(obj.1, false);
        assert_eq!(obj.2, 0x01);
        assert_eq!(
            serialize::<_, Lsb0, u8, EndianEncoding>(&obj).unwrap(),
            data.view_bits::<Lsb0>().to_bitvec()
        )
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct VectorTest(f64, Vec<bool>);

    #[test]
    fn vector_test() {
        let obj = VectorTest(1.104321, vec![true, true, false, false, true, true]);
        let bits = serialize::<_, Lsb0, u8, EndianEncoding>(&obj).unwrap();
        assert_eq!(bits.len(), 102);
        let (obj2, _) = deserialize::<VectorTest, _, _, EndianEncoding>(bits.as_bitslice()).unwrap();
        assert_eq!(obj, obj2);
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    enum TestEnum {
        False(bool),
        True(u32),
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct TestEnumStruct(Vec<TestEnum>);

    #[test]
    fn enum_test() {
        let test = TestEnumStruct(vec![
            TestEnum::False(true),
            TestEnum::True(102040),
            TestEnum::False(false),
        ]);
        let bits = serialize::<_, Lsb0, u8, EndianEncoding>(&test).unwrap();
        let (test2, _) =
            deserialize::<TestEnumStruct, _, _, EndianEncoding>(bits.as_bitslice()).unwrap();
        assert_eq!(test, test2);
    }

    #[derive(Serialize, Deserialize, PartialEq, Debug)]
    struct BooleanTest(Vec<bool>);

    #[bench]
    fn boolean(b: &mut Bencher) {
        // 4 ns/iter
        let obj = BooleanTest(vec![true, false]);
        b.iter(|| {
            let bits = serialize::<_, Lsb0, u8, EndianEncoding>(&obj).unwrap();
            deserialize::<BooleanTest, _, _, EndianEncoding>(bits.as_bitslice()).unwrap();
        })
    }
}