varing 0.14.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
407
408
use super::super::Packable;
use bnum_0_13::*;

macro_rules! impl_packable {
  ($($suffix:ident ($storage:literal)), +$(,)?) => {
    paste::paste! {
      $(
        #[doc = "Zigzag encode `B" $suffix "<N>` value"]
        #[inline]
        pub const fn [< zigzag_encode_ $suffix:snake >]<const N: usize>(value: &[< B $suffix:camel >]<N>) -> [< BU $suffix >]<N> {
          if N == 0 {
            return [< BU $suffix >]::<N>::ZERO;
          }

          let bits = match [< B $suffix:camel >]::<N>::BITS.checked_sub(1) {
            Some(val) => val,
            None => 0,
          };

          value.shl(1).bitxor(value.shr(bits as u32)).to_bits()
        }

        #[doc = "Zigzag decode `B" $suffix:camel "<N>` value"]
        #[inline]
        pub const fn [< zigzag_decode_ $suffix:snake >]<const N: usize>(value: &[< BU $suffix >]<N>) -> [< B $suffix:camel >]<N> {
          if N == 0 {
            return [< B $suffix:camel >]::<N>::ZERO;
          }

          let a = [< B $suffix:camel >]::<N>::from_bits(value.shr(1));
          let b = [< B $suffix:camel >]::<N>::from_bits(value.bitand([< BU $suffix >]::<N>::from_digit(1))).neg();
          a.bitxor(b)
        }

        #[doc = "Packs `BU`" $suffix "<L>` and `BU" $suffix "<R>` into a single `BU" $suffix "<P>` value."]
        pub const fn [< pack_u $suffix:snake>]<const L: usize, const R: usize, const P: usize>(a: &[< BU $suffix >]<L>, b: &[< BU $suffix >]<R>) -> [< BU $suffix >]<P> {
          assert!(L <= P && R <= P - L, "L + R must be less than or equal to P");

          if L == 0 && R == 0 {
            return [< BU $suffix >]::<P>::ZERO;
          }

          let mut low = [0; P];
          let mut high = [0; P];

          // Determine which input has smaller size (in bits)
          let (high_bits, high_value, low_value, low_bits) = if L > R {
            let b_digits = b.digits();
            let mut idx = 0;
            while idx < R {
              low[idx] = b_digits[idx];
              idx += 1;
            }

            let a_digits = a.digits();
            idx = 0;
            while idx < L {
              high[idx] = a_digits[idx];
              idx += 1;
            }

            let low = [< BU $suffix >]::<P>::from_digits(low);
            let high = [< BU $suffix >]::<P>::from_digits(high);

            (L * $storage, high, low, R * $storage)
          } else {
            let a_digits = a.digits();
            let mut idx = 0;
            while idx < L {
              low[idx] = a_digits[idx];
              idx += 1;
            }

            let b_digits = b.digits();
            idx = 0;
            while idx < R {
              high[idx] = b_digits[idx];
              idx += 1;
            }

            let low = [< BU $suffix >]::<P>::from_digits(low);
            let high = [< BU $suffix >]::<P>::from_digits(high);

            (R * $storage, high, low, L * $storage)
          };

          // Create mask for the low value to ensure it doesn't exceed its bit width
          let low_mask = if low_bits == { P * $storage } {
            [< BU $suffix >]::<P>::MAX
          } else {
            [< BU $suffix >]::<P>::ONE.shl(low_bits as u32).sub([< BU $suffix >]::<P>::ONE)
          };

          // Apply mask to low value
          let masked_low = low_value.bitand(low_mask);

          // Create mask for the high value
          let high_mask = if high_bits == { P * $storage } {
            [< BU $suffix >]::<P>::MAX
          } else {
            [< BU $suffix >]::<P>::ONE.shl(high_bits as u32).sub([< BU $suffix >]::<P>::ONE)
          };

          // Apply mask to high value, shift it to proper position, and combine with low value
          let masked_high = high_value.bitand(high_mask);

          masked_high.shl(low_bits as u32).bitor(masked_low)
        }

        #[doc = "Unpacks `BU`" $suffix "<P>` into `BU" $suffix "<L>` and `BU" $suffix "<R>`"]
        pub const fn [< unpack_u $suffix:snake >]<const L: usize, const R: usize, const P: usize>(packed: [< BU $suffix >]<P>) -> ([< BU $suffix >]<L>, [< BU $suffix >]<R>) {
          assert!(L <= P && R <= P - L, "L + R must be less than or equal to P");

          if L == 0 && R == 0 {
            return ([< BU $suffix >]::<L>::ZERO, [< BU $suffix >]::<R>::ZERO);
          }

          // Determine which value was placed in high bits vs low bits
          let low_bits = if L > R {
            R * $storage
          } else {
            L * $storage
          };

          // Create masks for extracting each value
          let low_mask = if low_bits == { P * $storage } {
            [< BU $suffix >]::<P>::MAX
          } else {
            [< BU $suffix >]::<P>::ONE.shl(low_bits as u32).sub([< BU $suffix >]::<P>::ONE)
          };

          // Extract the low bits part
          let low_value = packed.bitand(low_mask);

          // Extract the high bits part
          let high_value = packed.shr(low_bits as u32);

          if L > R {
            let mut lhs = [0; L];
            let high_digits = high_value.digits();
            let mut idx = 0;
            while idx < L {
              lhs[idx] = high_digits[idx];
              idx += 1;
            }
            let lhs = [< BU $suffix >]::<L>::from_digits(lhs);

            let mut rhs = [0; R];
            let low_digits = low_value.digits();
            idx = 0;
            while idx < R {
              rhs[idx] = low_digits[idx];
              idx += 1;
            }
            let rhs = [< BU $suffix >]::<R>::from_digits(rhs);
            (lhs, rhs)
          } else {
            let mut lhs = [0; L];
            let low_digits = low_value.digits();
            let mut idx = 0;
            while idx < L {
              lhs[idx] = low_digits[idx];
              idx += 1;
            }
            let lhs = [< BU $suffix >]::<L>::from_digits(lhs);

            let mut rhs = [0; R];
            let high_digits = high_value.digits();
            idx = 0;
            while idx < R {
              rhs[idx] = high_digits[idx];
              idx += 1;
            }
            let rhs = [< BU $suffix >]::<R>::from_digits(rhs);
            (lhs, rhs)
          }
        }

        #[doc = "Packs `B`" $suffix:camel "<L>` and `B" $suffix:camel "<R>` into a single `BU" $suffix "<P>` value."]
        #[inline]
        pub const fn [< pack_ $suffix:snake>]<const L: usize, const R: usize, const P: usize>(a: &[< B $suffix:camel >]<L>, b: &[< B $suffix:camel >]<R>) -> [< BU $suffix >]<P> {
          if L == 0 && R == 0 {
            return [< BU $suffix >]::<P>::ZERO;
          }

          let a = [< zigzag_encode_ $suffix:snake >](&a);
          let b = [< zigzag_encode_ $suffix:snake >](&b);
          [< pack_u $suffix:snake >](&a, &b)
        }

        #[doc = "Unpacks `BU`" $suffix "<P>` into `B" $suffix:camel "<L>` and `B" $suffix:camel "<R>`"]
        #[inline]
        pub const fn [< unpack_ $suffix:snake >]<const L: usize, const R: usize, const P: usize>(packed: [< BU $suffix >]<P>) -> ([< B $suffix:camel >]<L>, [< B $suffix:camel >]<R>) {
          if L == 0 && R == 0 {
            return ([< B $suffix:camel >]::<L>::ZERO, [< B $suffix:camel >]::<R>::ZERO);
          }

          let (a, b) = [< unpack_u $suffix:snake >](packed);
          let a = [< zigzag_decode_ $suffix:snake >](&a);
          let b = [< zigzag_decode_ $suffix:snake >](&b);
          (a, b)
        }

        #[doc = "Packs `B`" $suffix:camel "<L>` and `BU" $suffix "<R>` into a single `BU" $suffix "<P>` value."]
        #[inline]
        pub const fn [< pack_ $suffix:snake _u $suffix:snake>]<const L: usize, const R: usize, const P: usize>(a: &[< B $suffix:camel >]<L>, b: &[< BU $suffix >]<R>) -> [< BU $suffix >]<P> {
          if L == 0 && R == 0 {
            return [< BU $suffix >]::<P>::ZERO;
          }

          let a = [< zigzag_encode_ $suffix:snake >](&a);
          [< pack_u $suffix:snake >](&a, b)
        }

        #[doc = "Unpacks `BU`" $suffix "<P>` into `B" $suffix:camel "<L>` and `BU" $suffix "<R>`"]
        #[inline]
        pub const fn [< unpack_ $suffix:snake _u $suffix:snake >]<const L: usize, const R: usize, const P: usize>(packed: [< BU $suffix >]<P>) -> ([< B $suffix:camel >]<L>, [< BU $suffix >]<R>) {
          if L == 0 && R == 0 {
            return ([< B $suffix:camel >]::<L>::ZERO, [< BU $suffix >]::<R>::ZERO);
          }

          let (a, b) = [< unpack_u $suffix:snake >](packed);
          let a = [< zigzag_decode_ $suffix:snake >](&a);
          (a, b)
        }

        #[doc = "Packs `B`" $suffix:camel "<L>` and `BU" $suffix "<R>` into a single `BU" $suffix "<P>` value."]
        #[inline]
        pub const fn [< pack_u $suffix:snake _ $suffix:snake>]<const L: usize, const R: usize, const P: usize>(a: &[< BU $suffix >]<L>, b: &[< B $suffix:camel >]<R>) -> [< BU $suffix >]<P> {
          if L == 0 && R == 0 {
            return [< BU $suffix >]::<P>::ZERO;
          }

          let b = [< zigzag_encode_ $suffix:snake >](&b);
          [< pack_u $suffix:snake >](a, &b)
        }

        #[doc = "Unpacks `BU`" $suffix "<P>` into `BU" $suffix "<L>` and `B" $suffix:camel "<R>`"]
        #[inline]
        pub const fn [< unpack_u $suffix:snake _ $suffix:snake >]<const L: usize, const R: usize, const P: usize>(packed: [< BU $suffix >]<P>) -> ([< BU $suffix >]<L>, [< B $suffix:camel >]<R>) {
          if L == 0 && R == 0 {
            return ([< BU $suffix >]::<L>::ZERO, [< B $suffix:camel >]::<R>::ZERO);
          }

          let (a, b) = [< unpack_u $suffix:snake >](packed);
          let b = [< zigzag_decode_ $suffix:snake >](&b);
          (a, b)
        }

        impl<const L: usize, const R: usize, const P: usize> Packable<[< BU $suffix>]<R>, [< BU $suffix>]<P>> for [< BU $suffix>]<L> {
          fn pack(&self, rhs: &[< BU $suffix>]<R>) -> [< BU $suffix>]<P> {
            [< pack_u $suffix:snake >](self, rhs)
          }

          fn unpack(packed: [< BU $suffix>]<P>) -> (Self, [< BU $suffix>]<R>)
          where
            Self: Sized,
            BUint<R>: Sized
          {
            [< unpack_u $suffix:snake >](packed)
          }
        }

        impl<const L: usize, const R: usize, const P: usize> Packable<[< B $suffix:camel>]<R>, [< BU $suffix>]<P>> for [< B $suffix:camel >]<L> {
          fn pack(&self, rhs: &[< B $suffix:camel >]<R>) -> [< BU $suffix>]<P> {
            [< pack_ $suffix:snake >](self, rhs)
          }

          fn unpack(packed: [< BU $suffix>]<P>) -> (Self, [< B $suffix:camel>]<R>)
          where
            Self: Sized,
            BUint<R>: Sized
          {
            [< unpack_ $suffix:snake >](packed)
          }
        }

        impl<const L: usize, const R: usize, const P: usize> Packable<[< B $suffix:camel>]<R>, [< BU $suffix>]<P>> for [< BU $suffix>]<L> {
          fn pack(&self, rhs: &[< B $suffix:camel>]<R>) -> [< BU $suffix>]<P> {
            [< pack_u $suffix:snake _ $suffix:snake >](self, rhs)
          }

          fn unpack(packed: [< BU $suffix>]<P>) -> (Self, [< B $suffix:camel>]<R>)
          where
            Self: Sized,
            BUint<R>: Sized
          {
            [< unpack_u $suffix:snake _ $suffix:snake >](packed)
          }
        }

        impl<const L: usize, const R: usize, const P: usize> Packable<[< BU $suffix>]<R>, [< BU $suffix>]<P>> for [< B $suffix:camel>]<L> {
          fn pack(&self, rhs: &[< BU $suffix>]<R>) -> [< BU $suffix>]<P> {
            [< pack_ $suffix:snake _u $suffix:snake >](self, rhs)
          }

          fn unpack(packed: [< BU $suffix>]<P>) -> (Self, [< BU $suffix>]<R>)
          where
            Self: Sized,
            BUint<R>: Sized
          {
            [< unpack_ $suffix:snake _u $suffix:snake >](packed)
          }
        }

        #[cfg(test)]
        fn [< roundtrip_u $suffix:snake _test>]<const L: usize, const R: usize, const P: usize>(lhs: [< BU $suffix>]<L>, rhs: [< BU $suffix>]<R>) -> bool {
          let packed = <[< BU $suffix>]<L> as Packable<[< BU $suffix>]<R>, [< BU $suffix>]<P>>>::pack(&lhs, &rhs);
          let (lhs2, rhs2) = <[< BU $suffix>]<L> as Packable<[< BU $suffix>]<R>, _>>::unpack(packed);
          lhs == lhs2 && rhs == rhs2
        }

        #[cfg(test)]
        fn [< roundtrip_ $suffix:snake _test>]<const L: usize, const R: usize, const P: usize>(lhs: [< B $suffix: camel>]<L>, rhs: [< B $suffix: camel>]<R>) -> bool {
          let packed = <[< B $suffix: camel>]<L> as Packable<[< B $suffix:camel>]<R>, [< BU $suffix>]<P>>>::pack(&lhs, &rhs);
          let (lhs2, rhs2) = <[< B $suffix: camel>]<L> as Packable<[< B $suffix: camel>]<R>, _>>::unpack(packed);
          lhs == lhs2 && rhs == rhs2
        }

        #[cfg(test)]
        fn [< roundtrip_u $suffix:snake _ $suffix:snake _test>]<const L: usize, const R: usize, const P: usize>(lhs: [< BU $suffix>]<L>, rhs: [< B $suffix:camel>]<R>) -> bool {
          let packed = <[< BU $suffix>]<L> as Packable<[< B $suffix:camel>]<R>, [< BU $suffix>]<P>>>::pack(&lhs, &rhs);
          let (lhs2, rhs2) = <[< BU $suffix>]<L> as Packable<[< B $suffix:camel>]<R>, _>>::unpack(packed);
          lhs == lhs2 && rhs == rhs2
        }

        #[cfg(test)]
        fn [< roundtrip_ $suffix:snake _u $suffix:snake _test>]<const L: usize, const R: usize, const P: usize>(lhs: [< B $suffix:camel>]<L>, rhs: [< BU $suffix>]<R>) -> bool {
          let packed = <[< B $suffix:camel>]<L> as Packable<[< BU $suffix>]<R>, [< BU $suffix>]<P>>>::pack(&lhs, &rhs);
          let (lhs2, rhs2) = <[< B $suffix:camel>]<L> as Packable<[< BU $suffix>]<R>, _>>::unpack(packed);
          lhs == lhs2 && rhs == rhs2
        }

        #[cfg(test)]
        #[test]
        fn [< packable_u $suffix:snake _width_order_roundtrips>]() {
          const LESS_LHS: [< BU $suffix>]<1> = [< BU $suffix>]::from_digits([0x12]);
          const LESS_RHS: [< BU $suffix>]<2> = [< BU $suffix>]::from_digits([0x34, 0x56]);
          const LESS_PACKED: [< BU $suffix>]<3> =
            [< pack_u $suffix:snake >]::<1, 2, 3>(&LESS_LHS, &LESS_RHS);
          const LESS_UNPACKED: ([< BU $suffix>]<1>, [< BU $suffix>]<2>) =
            [< unpack_u $suffix:snake >]::<1, 2, 3>(LESS_PACKED);
          assert_eq!(LESS_PACKED.digits(), &[0x12, 0x34, 0x56]);
          assert_eq!(LESS_UNPACKED, (LESS_LHS, LESS_RHS));
          assert!([< roundtrip_u $suffix:snake _test>]::<1, 2, 3>(LESS_LHS, LESS_RHS));

          const EQUAL_LHS: [< BU $suffix>]<2> = [< BU $suffix>]::from_digits([0x12, 0x34]);
          const EQUAL_RHS: [< BU $suffix>]<2> = [< BU $suffix>]::from_digits([0x56, 0x78]);
          const EQUAL_PACKED: [< BU $suffix>]<4> =
            [< pack_u $suffix:snake >]::<2, 2, 4>(&EQUAL_LHS, &EQUAL_RHS);
          const EQUAL_UNPACKED: ([< BU $suffix>]<2>, [< BU $suffix>]<2>) =
            [< unpack_u $suffix:snake >]::<2, 2, 4>(EQUAL_PACKED);
          assert_eq!(EQUAL_PACKED.digits(), &[0x12, 0x34, 0x56, 0x78]);
          assert_eq!(EQUAL_UNPACKED, (EQUAL_LHS, EQUAL_RHS));
          assert!([< roundtrip_u $suffix:snake _test>]::<2, 2, 4>(EQUAL_LHS, EQUAL_RHS));

          const GREATER_LHS: [< BU $suffix>]<2> = [< BU $suffix>]::from_digits([0x12, 0x34]);
          const GREATER_RHS: [< BU $suffix>]<1> = [< BU $suffix>]::from_digits([0x56]);
          const GREATER_PACKED: [< BU $suffix>]<3> =
            [< pack_u $suffix:snake >]::<2, 1, 3>(&GREATER_LHS, &GREATER_RHS);
          const GREATER_UNPACKED: ([< BU $suffix>]<2>, [< BU $suffix>]<1>) =
            [< unpack_u $suffix:snake >]::<2, 1, 3>(GREATER_PACKED);
          assert_eq!(GREATER_PACKED.digits(), &[0x56, 0x12, 0x34]);
          assert_eq!(GREATER_UNPACKED, (GREATER_LHS, GREATER_RHS));
          assert!([< roundtrip_u $suffix:snake _test>]::<2, 1, 3>(GREATER_LHS, GREATER_RHS));
        }
      )*
    }
  };
}

impl_packable!(intD8(8), intD16(16), intD32(32), int(64),);

macro_rules! fuzzy_packable {
  ( $( $suffix:ident ($($bits: literal), +$(,)?) ), +$(,)? ) => {
    paste::paste! {
      $(
        $(
          #[cfg(test)]
          quickcheck::quickcheck! {
            fn [< fuzzy_u $suffix:snake _ $bits _roundtrip>](a: [< BU $suffix>]<{ $bits / 8 }>, b: [< BU $suffix>]<{ $bits / 8 }>) -> bool {
              [< roundtrip_u $suffix:snake _test>]::<{$bits / 8}, {$bits / 8}, { ($bits / 8) * 2}>(a, b)
            }

            fn [< fuzzy_ $suffix:snake _ $bits _roundtrip>](a: [< B $suffix:camel>]<{ $bits / 8 }>, b: [< B $suffix:camel>]<{ $bits / 8 }>) -> bool {
              [< roundtrip_ $suffix:snake _test>]::<{$bits / 8}, {$bits / 8}, { ($bits / 8) * 2}>(a, b)
            }

            fn [< fuzzy_u $suffix:snake _ $suffix:snake _ $bits _roundtrip>](a: [< BU $suffix>]<{ $bits / 8 }>, b: [< B $suffix:camel>]<{ $bits / 8 }>) -> bool {
              [< roundtrip_u $suffix:snake _ $suffix:snake _test>]::<{$bits / 8}, {$bits / 8}, { ($bits / 8) * 2}>(a, b)
            }

            fn [< fuzzy_ $suffix:snake _u $suffix:snake _ $bits _roundtrip>](a: [< B $suffix:camel>]<{ $bits / 8 }>, b: [< BU $suffix>]<{ $bits / 8 }>) -> bool {
              [< roundtrip_ $suffix:snake _u $suffix:snake _test>]::<{$bits / 8}, {$bits / 8}, { ($bits / 8) * 2}>(a, b)
            }
          }
        )*
      )*
    }
  };
}

fuzzy_packable!(
  intD8(8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192),
  intD16(8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192),
  intD32(8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192),
  int(8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192),
);