varing 0.13.0

Protobuf's varint encoding/decoding for LEB128 friendly types with full const context operations supports.
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use arbitrary_int_2::prelude::*;

use core::num::NonZeroUsize;

use crate::{utils::Buffer, *};

macro_rules! generate {
  ($($storage:ident($start:literal..=$end:literal)), +$(,)?) => {
    $(
      seq_macro::seq!(N in $start..=$end {
        generate!($storage(
          #(
            u~N,
          )*
        ));
      });
    )*
  };
  ($($underlying:ident($($inner:ident), +$(,)?)),+$(,)?) => {
    $(
      $(
        paste::paste! {
          /// Returns the encoded length of the value in LEB128 variable length format.
          #[doc = "The returned value will be in range of [`" $inner "::ENCODED_LEN_RANGE`]."]
          #[inline]
          pub const fn [< encoded_ $inner _varint_len >](value: $inner) -> NonZeroUsize {
            [<encoded_ $underlying _varint_len>](value.value())
          }

          #[doc = "Encodes an `" $inner "` value into LEB128 variable length format, and writes it to the buffer."]
          #[inline]
          pub const fn [< encode_ $inner _varint >](x: $inner) -> $crate::utils::Buffer<{ $inner::MAX_ENCODED_LEN.get() + 1 }> {
            let mut buf = [0; { $inner::MAX_ENCODED_LEN.get() + 1 }];
            let len = match [< encode_ $inner _varint_to >](x, &mut buf) {
              Ok(len) => len,
              Err(_) => panic!("buffer should be large enough"),
            };
            buf[$crate::utils::Buffer::<{ $inner::MAX_ENCODED_LEN.get() + 1 }>::CAPACITY.get()] = len.get() as u8;
            $crate::utils::Buffer::new(buf)
          }

          #[doc = "Encodes an `" $inner "` value into LEB128 variable length format, and writes it to the buffer."]
          #[inline]
          pub const fn [< encode_ $inner _varint_to >](value: $inner, buf: &mut [u8]) -> Result<NonZeroUsize, ConstEncodeError> {
            [<encode_ $underlying _varint_to>](value.value(), buf)
          }

          #[doc = "Decodes an `" $inner "` in LEB128 encoded format from the buffer."]
          ///
          /// Returns the bytes read and the decoded value if successful.
          #[inline]
          pub const fn [< decode_ $inner _varint >](buf: &[u8]) -> Result<(NonZeroUsize, $inner), ConstDecodeError> {
            match [<decode_ $underlying _varint>](buf) {
              Ok((readed, val)) => {
                match $inner::try_new(val) {
                  Ok(val) => Ok((readed, val)),
                  Err(_) => Err(ConstDecodeError::Overflow),
                }
              },
              Err(err) => Err(err),
            }
          }

          #[cfg(test)]
          #[derive(Debug, Clone, Copy, PartialEq, Eq)]
          struct [< Fuzzy $inner:camel >]($inner);

          #[cfg(test)]
          const _: () = {
            use quickcheck::{Arbitrary, Gen};

            impl Arbitrary for [< Fuzzy $inner:camel >] {
              fn arbitrary(g: &mut Gen) -> Self {
                let val = loop {
                  let val = $underlying::arbitrary(g);
                  if val >= $inner::MIN.[<as_ $underlying>]() && val <= $inner::MAX.[<as_ $underlying>]() {
                    break val;
                  }
                };
                Self($inner::try_new(val).unwrap())
              }
            }
          };

          #[cfg(test)]
          quickcheck::quickcheck! {
            fn [< fuzzy_ $inner _varint >](x: [< Fuzzy $inner:camel >]) -> bool {
              let x = x.0;
              let mut buf = [0; $inner::MAX_ENCODED_LEN.get()];
              let len = [< encode_ $inner _varint_to >](x, &mut buf).unwrap();
              let buffer = [< encode_ $inner _varint >](x);
              assert_eq!(buffer.len(), len.get());
              assert_eq!(buffer.as_slice(), &buf[..len.get()]);

              let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
              assert_eq!(readed, len);
              assert_eq!(val, x);

              true
            }
          }

          #[test]
          fn [< test_ $inner _min_max_varint >]() {
            let min = $inner::MIN;
            let max = $inner::MAX;
            let min_encoded_len = [< encoded_ $inner _varint_len >](min);
            let max_encoded_len = [< encoded_ $inner _varint_len >](max);

            assert_eq!(min_encoded_len, $inner::MIN_ENCODED_LEN);
            assert_eq!(max_encoded_len, $inner::MAX_ENCODED_LEN);

            let mut buf = [0; $inner::MAX_ENCODED_LEN.get()];
            let len = [< encode_ $inner _varint_to >](min, &mut buf).unwrap();
            assert_eq!(len, min_encoded_len);
            let buffer = [< encode_ $inner _varint >](min);
            assert_eq!(buffer.len(), min_encoded_len.get());
            assert_eq!(buffer.as_slice(), &buf[..min_encoded_len.get()]);

            let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
            assert_eq!(readed, len);
            assert_eq!(val, min);

            let len = [< encode_ $inner _varint_to >](max, &mut buf).unwrap();
            assert_eq!(len, max_encoded_len);
            let buffer = [< encode_ $inner _varint >](max);
            assert_eq!(buffer.len(), max_encoded_len.get());
            assert_eq!(buffer.as_slice(), &buf[..max_encoded_len.get()]);

            let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
            assert_eq!(readed, len);
            assert_eq!(val, max);
          }
        }
      )*
    )*
  };
  ($($storage:literal), +$(,)?) => {
    paste::paste! {
      $(
        #[doc = "Returns the encoded length of the value in LEB128 variable length format."]
        pub const fn [< encoded_uint_d $storage _len >]<const BITS: usize>(value: UInt<[< u $storage>], BITS>) -> NonZeroUsize {
          [< encoded_u $storage _varint_len >](value.value())
        }

        #[doc = "Encodes an `Uint<u" $storage ", BITS>` value into LEB128 variable length format, and writes it to the buffer."]
        pub const fn [< encode_uint_d $storage _to >]<const BITS: usize>(value: UInt<[< u $storage>], BITS>, buf: &mut [u8]) -> Result<NonZeroUsize, ConstEncodeError> {
          [< encode_u $storage _varint_to >](value.value(), buf)
        }

        #[doc = "Encodes an `Uint<u" $storage ", BITS>` value into LEB128 variable length format, and writes it to the buffer."]
        pub const fn [< encode_uint_d $storage>]<const BITS: usize>(value: UInt<[< u $storage>], BITS>) -> Buffer<{ [< u $storage>]::MAX_ENCODED_LEN.get() + 1 }> {
          [< encode_u $storage _varint >](value.value())
        }

        #[doc = "Decodes an `Uint<u" $storage ", BITS>` in LEB128 encoded format from the buffer."]
        pub const fn [< decode_uint_d $storage>]<const BITS: usize>(buf: &[u8]) -> Result<(NonZeroUsize, UInt<[< u $storage>], BITS>), ConstDecodeError> {
          match [< decode_u $storage _varint >](buf) {
            Ok((readed, val)) => {
              match UInt::<[< u $storage>], BITS>::try_new(val) {
                Ok(val) => Ok((readed, val)),
                Err(_) => Err(ConstDecodeError::Overflow),
              }
            }
            Err(err) => Err(err),
          }
        }

        impl<const BITS: usize> Varint for UInt<[< u $storage>], BITS> {
          const MIN_ENCODED_LEN: NonZeroUsize = [< encoded_uint_d $storage _len >](UInt::<[< u $storage>], BITS>::MIN);
          const MAX_ENCODED_LEN: NonZeroUsize = [< encoded_uint_d $storage _len >](UInt::<[< u $storage>], BITS>::MAX);

          fn encoded_len(&self) -> NonZeroUsize {
            [< encoded_uint_d $storage _len >](*self)
          }

          fn encode(&self, buf: &mut [u8]) -> Result<NonZeroUsize, crate::EncodeError> {
            [< encode_uint_d $storage _to >](*self, buf).map_err(Into::into)
          }

          fn decode(buf: &[u8]) -> Result<(NonZeroUsize, Self), crate::DecodeError>
          where
            Self: Sized,
          {
            [< decode_uint_d $storage >](buf).map_err(Into::into)
          }
        }
      )*
    }
  };
}

generate!(
  u8(1..=7),
  u16(9..=15),
  u32(17..=31),
  u64(33..=63),
  u128(65..=127),
);

generate!(8, 16, 32, 64, 128,);

// --- Signed type support (arbitrary-int v2) ---

macro_rules! generate_signed {
  ($($storage:ident($start:literal..=$end:literal)), +$(,)?) => {
    $(
      seq_macro::seq!(N in $start..=$end {
        generate_signed!($storage(
          #(
            i~N,
          )*
        ));
      });
    )*
  };
  ($($underlying:ident($($inner:ident), +$(,)?)),+$(,)?) => {
    $(
      $(
        paste::paste! {
          /// Returns the encoded length of the value in LEB128 variable length format.
          #[doc = "The returned value will be in range of [`" $inner "::ENCODED_LEN_RANGE`]."]
          #[inline]
          pub const fn [< encoded_ $inner _varint_len >](value: $inner) -> NonZeroUsize {
            [<encoded_ $underlying _varint_len>](value.value())
          }

          #[doc = "Encodes an `" $inner "` value into LEB128 variable length format, and writes it to the buffer."]
          #[inline]
          pub const fn [< encode_ $inner _varint >](x: $inner) -> $crate::utils::Buffer<{ <$inner as Varint>::MAX_ENCODED_LEN.get() + 1 }> {
            let mut buf = [0; { <$inner as Varint>::MAX_ENCODED_LEN.get() + 1 }];
            let len = match [< encode_ $inner _varint_to >](x, &mut buf) {
              Ok(len) => len,
              Err(_) => panic!("buffer should be large enough"),
            };
            buf[$crate::utils::Buffer::<{ <$inner as Varint>::MAX_ENCODED_LEN.get() + 1 }>::CAPACITY.get()] = len.get() as u8;
            $crate::utils::Buffer::new(buf)
          }

          #[doc = "Encodes an `" $inner "` value into LEB128 variable length format, and writes it to the buffer."]
          #[inline]
          pub const fn [< encode_ $inner _varint_to >](value: $inner, buf: &mut [u8]) -> Result<NonZeroUsize, ConstEncodeError> {
            [<encode_ $underlying _varint_to>](value.value(), buf)
          }

          #[doc = "Decodes an `" $inner "` in LEB128 encoded format from the buffer."]
          ///
          /// Returns the bytes read and the decoded value if successful.
          #[inline]
          pub const fn [< decode_ $inner _varint >](buf: &[u8]) -> Result<(NonZeroUsize, $inner), ConstDecodeError> {
            match [<decode_ $underlying _varint>](buf) {
              Ok((readed, val)) => {
                match $inner::try_new(val) {
                  Ok(val) => Ok((readed, val)),
                  Err(_) => Err(ConstDecodeError::Overflow),
                }
              },
              Err(err) => Err(err),
            }
          }

          #[cfg(test)]
          #[derive(Debug, Clone, Copy, PartialEq, Eq)]
          struct [< FuzzySigned $inner:camel >]($inner);

          #[cfg(test)]
          const _: () = {
            use quickcheck::{Arbitrary, Gen};
            impl Arbitrary for [< FuzzySigned $inner:camel >] {
              fn arbitrary(g: &mut Gen) -> Self {
                let val = loop {
                  let val = $underlying::arbitrary(g);
                  if val >= $inner::MIN.value() && val <= $inner::MAX.value() {
                    break val;
                  }
                };
                Self($inner::try_new(val).unwrap())
              }
            }
          };

          #[cfg(test)]
          quickcheck::quickcheck! {
            fn [< fuzzy_ $inner _varint >](x: [< FuzzySigned $inner:camel >]) -> bool {
              let x = x.0;
              let mut buf = [0; <$inner as Varint>::MAX_ENCODED_LEN.get()];
              let len = [< encode_ $inner _varint_to >](x, &mut buf).unwrap();
              let buffer = [< encode_ $inner _varint >](x);
              assert_eq!(buffer.len(), len.get());
              assert_eq!(buffer.as_slice(), &buf[..len.get()]);

              let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
              assert_eq!(readed, len);
              assert_eq!(val, x);

              true
            }
          }

          #[test]
          fn [< test_ $inner _min_max_varint >]() {
            let min = $inner::MIN;
            let max = $inner::MAX;
            let min_encoded_len = [< encoded_ $inner _varint_len >](min);
            let max_encoded_len = [< encoded_ $inner _varint_len >](max);

            assert_eq!(min_encoded_len, <$inner as Varint>::MIN_ENCODED_LEN);
            assert_eq!(max_encoded_len, <$inner as Varint>::MAX_ENCODED_LEN);

            let mut buf = [0; <$inner as Varint>::MAX_ENCODED_LEN.get()];
            let len = [< encode_ $inner _varint_to >](min, &mut buf).unwrap();
            assert_eq!(len, min_encoded_len);
            let buffer = [< encode_ $inner _varint >](min);
            assert_eq!(buffer.len(), min_encoded_len.get());
            assert_eq!(buffer.as_slice(), &buf[..min_encoded_len.get()]);

            let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
            assert_eq!(readed, len);
            assert_eq!(val, min);

            let len = [< encode_ $inner _varint_to >](max, &mut buf).unwrap();
            assert_eq!(len, max_encoded_len);
            let buffer = [< encode_ $inner _varint >](max);
            assert_eq!(buffer.len(), max_encoded_len.get());
            assert_eq!(buffer.as_slice(), &buf[..max_encoded_len.get()]);

            let (readed, val) = [< decode_ $inner _varint >](&buf).unwrap();
            assert_eq!(readed, len);
            assert_eq!(val, max);
          }
        }
      )*
    )*
  };
  (@generic $($storage:literal), +$(,)?) => {
    paste::paste! {
      $(
        #[doc = "Returns the encoded length of the value in LEB128 variable length format."]
        pub const fn [< encoded_int_d $storage _len >]<const BITS: usize>(value: Int<[< i $storage>], BITS>) -> NonZeroUsize {
          [< encoded_i $storage _varint_len >](value.value())
        }

        #[doc = "Encodes an `Int<i" $storage ", BITS>` value into LEB128 variable length format, and writes it to the buffer."]
        pub const fn [< encode_int_d $storage _to >]<const BITS: usize>(value: Int<[< i $storage>], BITS>, buf: &mut [u8]) -> Result<NonZeroUsize, ConstEncodeError> {
          [< encode_i $storage _varint_to >](value.value(), buf)
        }

        #[doc = "Encodes an `Int<i" $storage ", BITS>` value into LEB128 variable length format, and writes it to the buffer."]
        pub const fn [< encode_int_d $storage>]<const BITS: usize>(value: Int<[< i $storage>], BITS>) -> Buffer<{ [< i $storage>]::MAX_ENCODED_LEN.get() + 1 }> {
          [< encode_i $storage _varint >](value.value())
        }

        #[doc = "Decodes an `Int<i" $storage ", BITS>` in LEB128 encoded format from the buffer."]
        pub const fn [< decode_int_d $storage>]<const BITS: usize>(buf: &[u8]) -> Result<(NonZeroUsize, Int<[< i $storage>], BITS>), ConstDecodeError> {
          match [< decode_i $storage _varint >](buf) {
            Ok((readed, val)) => {
              match Int::<[< i $storage>], BITS>::try_new(val) {
                Ok(val) => Ok((readed, val)),
                Err(_) => Err(ConstDecodeError::Overflow),
              }
            }
            Err(err) => Err(err),
          }
        }

        impl<const BITS: usize> Varint for Int<[< i $storage>], BITS> {
          const MIN_ENCODED_LEN: NonZeroUsize = [< encoded_int_d $storage _len >](Int::<[< i $storage>], BITS>::MIN);
          const MAX_ENCODED_LEN: NonZeroUsize = {
            let min_len = [< encoded_int_d $storage _len >](Int::<[< i $storage>], BITS>::MIN);
            let max_len = [< encoded_int_d $storage _len >](Int::<[< i $storage>], BITS>::MAX);
            if min_len.get() > max_len.get() {
              min_len
            } else {
              max_len
            }
          };

          fn encoded_len(&self) -> NonZeroUsize {
            [< encoded_int_d $storage _len >](*self)
          }

          fn encode(&self, buf: &mut [u8]) -> Result<NonZeroUsize, crate::EncodeError> {
            [< encode_int_d $storage _to >](*self, buf).map_err(Into::into)
          }

          fn decode(buf: &[u8]) -> Result<(NonZeroUsize, Self), crate::DecodeError>
          where
            Self: Sized,
          {
            [< decode_int_d $storage >](buf).map_err(Into::into)
          }
        }
      )*
    }
  };
}

generate_signed!(
  i8(1..=7),
  i16(9..=15),
  i32(17..=31),
  i64(33..=63),
  i128(65..=127),
);

generate_signed!(@generic 8, 16, 32, 64, 128,);