fexbluffers 0.1.2

Allocation optimized FlexBuffer implementation (Rust).
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::bitwidth::BitWidth::{W16, W32, W64, W8};
use bytes::{BufMut, BytesMut};

/// Represents the size of Flexbuffers data.
///
/// Flexbuffers automatically compresses numbers to the smallest possible width
/// (`250u64` is stored as `250u8`).
#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Serialize,
    Deserialize,
    Ord,
    num_enum::TryFromPrimitive,
)]
#[repr(u8)]
#[derive(Default)]
pub enum BitWidth {
    #[default]
    W8 = 0,
    W16 = 1,
    W32 = 2,
    W64 = 3,
}

pub const BIT_WIDTHS: [BitWidth; 4] = [W8, W16, W32, W64];

impl BitWidth {
    #[must_use]
    pub fn n_bytes(self) -> usize {
        1 << self as usize
    }
    pub fn from_nbytes(n: impl Into<usize>) -> Option<Self> {
        match n.into() {
            1 => Some(W8),
            2 => Some(W16),
            4 => Some(W32),
            8 => Some(W64),
            _ => None,
        }
    }
}

// TODO(cneo): Overloading with `from` is probably not the most readable idea in hindsight.
macro_rules! impl_bitwidth_from {
    ($from: ident, $w64: ident, $w32: ident, $w16: ident, $w8: ident) => {
        #[allow(clippy::cast_lossless, clippy::checked_conversions)]
        impl From<$from> for BitWidth {
            fn from(x: $from) -> BitWidth {
                let x = x as $w64;
                if x >= $w8::MIN as $w64 && x <= $w8::MAX as $w64 {
                    return W8;
                }
                if x >= $w16::MIN as $w64 && x <= $w16::MAX as $w64 {
                    return W16;
                }
                if x >= $w32::MIN as $w64 && x <= $w32::MAX as $w64 {
                    return W32;
                }
                W64
            }
        }
    };
}

impl_bitwidth_from!(u64, u64, u32, u16, u8);
impl_bitwidth_from!(usize, u64, u32, u16, u8);
impl_bitwidth_from!(i64, i64, i32, i16, i8);

#[allow(clippy::float_cmp, clippy::cast_possible_truncation)]
impl From<f64> for BitWidth {
    fn from(x: f64) -> BitWidth {
        if x == f64::from(x as f32) { W32 } else { W64 }
    }
}
impl From<f32> for BitWidth {
    fn from(_: f32) -> BitWidth {
        W32
    }
}

/// Zero pad `v` until `T` will be byte aligned when pushed.
pub fn align(buffer: &mut BytesMut, width: BitWidth) {
    let bytes = 1 << width as u8;
    let mut alignment = (bytes - buffer.len() % bytes) % bytes;

    loop {
        if alignment == 0 {
            break;
        }

        buffer.put_u8(0);
        alignment -= 1;
    }
}