binary_codec/
dyn_int.rs

1use crate::{DeserializationError, SerializationError, SerializerConfig};
2
3/// Gives encoded size in bytes
4///
5/// # Arguments
6/// * `nr` - number to encode
7pub fn encoded_size(nr: u128) -> usize {
8    let mut res = 0;
9    let mut nr = nr;
10    while nr > 0 {
11        nr /= 128;
12        res += 1;
13    }
14    res
15}
16
17/// Encodes a number into a vector of bytes.
18///
19/// # Arguments
20/// * `nr` - number to encode
21pub fn encode(nr: u128) -> Vec<u8> {
22    let mut res = Vec::new();
23    let mut nr = nr;
24    while nr > 0 {
25        let mut encoded = nr % 128;
26        nr /= 128;
27        if nr > 0 {
28            encoded |= 128;
29        }
30        res.push(encoded as u8);
31    }
32    res
33}
34
35/// Decodes a number from a slice of bytes.
36///
37/// # Arguments
38/// * `data` - slice of bytes to decode
39pub fn decode(data: &[u8]) -> u128 {
40    let mut num = 0;
41    let mut multiplier = 1;
42    for byte in data {
43        num += (*byte as u128 & 127) * multiplier;
44        multiplier *= 128;
45    }
46    num
47}
48
49/// Decodes a number from a slice of bytes when size of encoded number is unknown, returning the number and the number of bytes read.
50///
51/// # Arguments
52/// * `data` - slice of bytes to decode number from
53///
54/// # Returns
55/// * (number, bytes read)
56pub fn read_from_slice(data: &[u8]) -> Result<(u128, usize), DeserializationError> {
57    let mut idx = 0;
58    loop {
59        if idx > data.len() - 1 {
60            break Err(DeserializationError::NotEnoughBytes(1));
61        }
62
63        if (data[idx] & 1 << 7) == 0 {
64            break Ok((decode(&data[..=idx]), idx + 1));
65        }
66
67        idx += 1;
68    }
69}
70
71pub fn read_dynint(bytes: &[u8], config: &mut SerializerConfig) -> Result<u128, DeserializationError> {
72    config.reset_bits(true);
73    let (value, read_bytes) = read_from_slice(&bytes[config.pos..])?;
74    config.pos += read_bytes;
75    return Ok(value);
76}
77
78pub fn write_dynint(val: u128, bytes: &mut Vec<u8>, config: &mut SerializerConfig) -> Result<(), SerializationError> {
79    config.reset_bits(false);
80    let data = encode(val);
81    bytes.extend_from_slice(&data);
82    config.pos += data.len();
83    return Ok(());
84}
85
86#[cfg(test)]
87mod test {
88    use super::*;
89
90    #[test]
91    fn can_encode_decode_number() {
92        let number = 1234567890;
93        let encoded = encode(number);
94        let decoded = decode(&encoded);
95        assert_eq!(number, decoded);
96        assert_eq!(5, encoded.len()); // 1234567890 ~ 2^31, 7 bits per byte = 7 * 5 = 35
97    }
98
99    #[test]
100    fn can_decode_number() {
101        let nr = &[216u8, 4];
102        let res = decode(nr);
103        assert_eq!(600, res);
104    }
105
106    #[test]
107    fn can_decode_number_from_larger_slice() {
108        let nr = &[216u8, 4, 234, 19, 74];
109        let res = read_from_slice(nr).unwrap();
110        assert_eq!((600, 2), res);
111    }
112
113    #[test]
114    fn can_decode_number_in_4_bytes() {
115        let max_nr = 268435455; // max number in 4 bytes
116        let encoded = encode(max_nr);
117        assert_eq!(4, encoded.len());
118    }
119
120    #[test]
121    fn cant_decode_bignr_in_4_bytes() {
122        let max_nr = 268435456;
123        let encoded = encode(max_nr);
124        assert_ne!(4, encoded.len());
125    }
126
127    #[test]
128    fn cant_decode_slice_that_lies() {
129        let slice = &[0b10111110]; // slice notes there is a second byte (7th bit, right-to-left), but there's not
130        let decoded = read_from_slice(slice);
131        assert!(decoded.is_err());
132    }
133
134    #[test]
135    fn can_encode_nr_lt_128_in_1_byte() {
136        let encoded = encode(127);
137        assert_eq!(1, encoded.len());
138    }
139
140    #[test]
141    fn can_guess_encoded_size() {
142        let one_byte = 127;
143        assert_eq!(1, encoded_size(one_byte));
144
145        let two_bytes = 128;
146        assert_eq!(2, encoded_size(two_bytes));
147
148        let four_bytes = 268435455;
149        assert_eq!(4, encoded_size(four_bytes));
150    }
151}
binary_codec/dyn_int.rs

binary_codec/
dyn_int.rs
