protobin 0.6.0

A rust crate with basic functions to encode & decode Protocol Buffer binary messages.
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
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226

#[derive(Default, Debug, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct WireEncoder {
    /// Buffer where the encoded bytes will be written to.
    pub buf: Vec<u8>,
}

impl WireEncoder {
    /// Create a [`WireEncoder`] with a new `Vec`.
    pub fn new() -> WireEncoder {
        WireEncoder { buf: Vec::new() }
    }

    /// Create a [`WireEncoder`] with the given buffer.
    pub fn with_buf(buf: Vec<u8>) -> WireEncoder {
        WireEncoder { buf }
    }

    /// Add the given [`u32`] as VARINT to the `buf`.
    pub fn add_var_uint32(&mut self, value: u32) {
        // determine needed byte length
        if value < (1 << 7) {
            // 1 byte
            self.buf.push(value as u8);
        } else if value < (1 << (7 * 2)) {
            // 2 bytes
            self.buf
                .extend_from_slice(&[0b1000_0000 | (value as u8), (value >> 7) as u8]);
        } else if value < (1 << (7 * 3)) {
            // 3 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                ((value >> (7 * 2)) as u8),
            ]);
        } else if value < (1 << (7 * 4)) {
            // 4 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                ((value >> (7 * 3)) as u8),
            ]);
        } else {
            // 5 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                ((value >> (7 * 4)) as u8),
            ]);
        }
    }

    /// Add a protobuf `int32` to the `buf` encoded as VARINT.
    #[inline]
    pub fn add_var_int32(&mut self, value: i32) {
        self.add_var_uint32(u32::from_ne_bytes(value.to_ne_bytes()))
    }

    /// Add a protobuf `sint32` to the `buf` encoded as VARINT with zig zag encoding.
    #[inline]
    pub fn add_var_sint32(&mut self, value: i32) {
        let zigzag = (value << 1) ^ (value >> 31);
        self.add_var_uint32(u32::from_ne_bytes(zigzag.to_ne_bytes()))
    }

    /// Add the given [`u64`] as VARINT to the `buf`.
    pub fn add_var_uint64(&mut self, value: u64) {
        // determine needed byte length
        if value < (1 << 7) {
            // 1 byte
            self.buf.push(value as u8);
        } else if value < (1 << (7 * 2)) {
            // 2 bytes
            self.buf
                .extend_from_slice(&[0b1000_0000 | (value as u8), (value >> 7) as u8]);
        } else if value < (1 << (7 * 3)) {
            // 3 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                ((value >> (7 * 2)) as u8),
            ]);
        } else if value < (1 << (7 * 4)) {
            // 4 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                ((value >> (7 * 3)) as u8),
            ]);
        } else if value < (1 << (7 * 5)) {
            // 5 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                ((value >> (7 * 4)) as u8),
            ]);
        } else if value < (1 << (7 * 6)) {
            // 6 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                0b1000_0000 | ((value >> (7 * 4)) as u8),
                ((value >> (7 * 5)) as u8),
            ]);
        } else if value < (1 << (7 * 7)) {
            // 7 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8 & 0b0111_1111),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                0b1000_0000 | ((value >> (7 * 4)) as u8),
                0b1000_0000 | ((value >> (7 * 5)) as u8),
                ((value >> (7 * 6)) as u8),
            ]);
        } else if value < (1 << (7 * 8)) {
            // 8 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                0b1000_0000 | ((value >> (7 * 4)) as u8),
                0b1000_0000 | ((value >> (7 * 5)) as u8),
                0b1000_0000 | ((value >> (7 * 6)) as u8),
                ((value >> (7 * 7)) as u8),
            ]);
        } else if value < (1 << (7 * 9)) {
            // 9 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                0b1000_0000 | ((value >> (7 * 4)) as u8),
                0b1000_0000 | ((value >> (7 * 5)) as u8),
                0b1000_0000 | ((value >> (7 * 6)) as u8),
                0b1000_0000 | ((value >> (7 * 7)) as u8),
                ((value >> (7 * 8)) as u8),
            ]);
        } else {
            // 10 bytes
            self.buf.extend_from_slice(&[
                0b1000_0000 | (value as u8),
                0b1000_0000 | ((value >> 7) as u8),
                0b1000_0000 | ((value >> (7 * 2)) as u8),
                0b1000_0000 | ((value >> (7 * 3)) as u8),
                0b1000_0000 | ((value >> (7 * 4)) as u8),
                0b1000_0000 | ((value >> (7 * 5)) as u8),
                0b1000_0000 | ((value >> (7 * 6)) as u8),
                0b1000_0000 | ((value >> (7 * 7)) as u8),
                0b1000_0000 | ((value >> (7 * 8)) as u8),
                ((value >> (7 * 9)) as u8),
            ]);
        }
    }

    /// Add a protobuf `int64` to the `buf` encoded as VARINT.
    #[inline]
    pub fn add_var_int64(&mut self, value: i64) {
        self.add_var_uint64(u64::from_ne_bytes(value.to_ne_bytes()))
    }

    /// Add a protobuf `sint64` to the `buf` encoded as VARINT with zig zag encoding.
    #[inline]
    pub fn add_var_sint64(&mut self, value: i64) {
        let zigzag = (value << 1) ^ (value >> 63);
        self.add_var_uint64(u64::from_ne_bytes(zigzag.to_ne_bytes()))
    }

    /// Add a protobuf `bool` to the `buf` encoded as VARINT.
    #[inline]
    pub fn add_bool(&mut self, value: bool) {
        self.buf.push(if value { 1 } else { 0 });
    }

    /// Add the given [`u32`] as `fixed32`` to the `buf`.
    #[inline]
    pub fn add_fixed32(&mut self, value: u32) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Add the given [`i32`] as `sfixed32`` to the `buf`.
    #[inline]
    pub fn add_sfixed32(&mut self, value: i32) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Add the given [`u64`] as fixed64 to the `buf`.
    #[inline]
    pub fn add_fixed64(&mut self, value: u64) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Add the given [`i64`] as sfixed64 to the `buf`.
    #[inline]
    pub fn add_sfixed64(&mut self, value: i64) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Add the given [`f32`] as float to the `buf`.
    #[inline]
    pub fn add_float(&mut self, value: f32) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Add the given [`f64`] as double to the `buf`.
    #[inline]
    pub fn add_double(&mut self, value: f64) {
        self.buf.extend_from_slice(&value.to_le_bytes());
    }

    /// Destroys the [`WireEncoder`] and returns the `buf` of the destroyed
    /// [`WireEncoder`].
    #[inline]
    pub fn take_buf(self) -> Vec<u8> {
        self.buf
    }
}