bitcraft 0.9.3

A zero-cost, hardware-aligned bitfield and enumeration generator.
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
use bitcraft::{bitenum, bitstruct, bytestruct, byteval};
use proptest::prelude::*;

bitenum! {
    enum FuzzEnum(2) {
        A = 0,
        B = 1,
        C = 2,
    }
}

bitstruct! {
    struct FuzzStruct(u64) {
        a: bool = 1,
        b: u8 = 7,
        c: u32 = 24,
        d: FuzzEnum = 2,
        e: u32 = 30, // 1+7+24+2+30 = 64
    }
}

bytestruct! {
    struct FuzzByteStruct13(13) { // 104 bits
        flags: u8 = 8,
        coord_x: u32 = 32,
        coord_y: u32 = 32,
        state: FuzzEnum = 2,
        payload_meta: u32 = 30, // 8+32+32+2+30 = 104
    }
}

bytestruct! {
    struct CrossBoundaryFuzz(2) {
        low: u8 = 4,   // bits 0-3
        mid: u8 = 8,   // bits 4-11 (crosses byte 0-1)
        high: u8 = 4,  // bits 12-15
    }
}

bytestruct! {
    struct WideFuzz16(16) {
        start: bool = 1,
        large: u128 = 120, // bits 1-120
        end: u8 = 7,       // bits 121-127
    }
}

// Multiple byteval types for fuzzing
byteval! { struct FuzzId24(3); } // 24-bit
byteval! { struct FuzzId40(5); } // 40-bit
byteval! { struct FuzzId56(7); } // 56-bit
byteval! { struct FuzzId104(13); } // 104-bit

// Variety types for expanded coverage
byteval! { struct FuzzId48u16(3, u16); } // 48-bit with u16 storage
byteval! { struct FuzzId96u32(3, u32); } // 96-bit with u32 storage

bitstruct! {
    struct DenseFuzz(u32) {
        b00: bool = 1, b01: bool = 1, b02: bool = 1, b03: bool = 1,
        b04: bool = 1, b05: bool = 1, b06: bool = 1, b07: bool = 1,
        b08: bool = 1, b09: bool = 1, b10: bool = 1, b11: bool = 1,
        b12: bool = 1, b13: bool = 1, b14: bool = 1, b15: bool = 1,
        b16: bool = 1, b17: bool = 1, b18: bool = 1, b19: bool = 1,
        b20: bool = 1, b21: bool = 1, b22: bool = 1, b23: bool = 1,
        b24: bool = 1, b25: bool = 1, b26: bool = 1, b27: bool = 1,
        b28: bool = 1, b29: bool = 1, b30: bool = 1, b31: bool = 1,
    }
}

bytestruct! {
    #[repr(align(8))]
    struct AlignedFuzzer(8) {
        val: u64 = 64,
    }
}

bytestruct! {
    struct MixedStorageFuzzer([u64; 2]) {
        a: u128 = 80,
        b: u64 = 48, // 80 + 48 = 128 bits
    }
}

proptest! {
    #[test]
    fn test_bitstruct_roundtrip(
        a in any::<bool>(),
        b in 0u8..128,
        c in any::<u32>(),
        d_val in 0u8..3u8,
        e in 0u32..(1u32 << 30)
    ) {
        let d = match d_val {
            0 => FuzzEnum::A,
            1 => FuzzEnum::B,
            _ => FuzzEnum::C,
        };

        let s = FuzzStruct::default()
            .with_a(a)
            .with_b(b)
            .with_c(c & 0xFFFFFF) // 24 bits
            .with_d(d)
            .with_e(e);

        prop_assert_eq!(s.a(), a);
        prop_assert_eq!(s.b(), b);
        prop_assert_eq!(s.c(), c & 0xFFFFFF);
        prop_assert_eq!(s.d(), d);
        prop_assert_eq!(s.e(), e);

        // Verify isolation: bitwise reconstruction
        let mut expected = 0u64;
        expected |= a as u64;
        expected |= (b as u64) << 1;
        expected |= ((c & 0xFFFFFF) as u64) << (1 + 7);
        expected |= (d.to_bits() as u64) << (1 + 7 + 24);
        expected |= (e as u64) << (1 + 7 + 24 + 2);

        prop_assert_eq!(s.to_bits(), expected);
    }

    #[test]
    #[allow(clippy::needless_range_loop)]
    fn test_bytestruct13_roundtrip(
        flags in any::<u8>(),
        x in any::<u32>(),
        y in any::<u32>(),
        state_val in 0u8..3u8,
        meta in 0u32..(1u32 << 30)
    ) {
        let state = match state_val {
            0 => FuzzEnum::A,
            1 => FuzzEnum::B,
            _ => FuzzEnum::C,
        };

        let s = FuzzByteStruct13::default()
            .with_flags(flags)
            .with_coord_x(x)
            .with_coord_y(y)
            .with_state(state)
            .with_payload_meta(meta);

        prop_assert_eq!(s.flags(), flags);
        prop_assert_eq!(s.coord_x(), x);
        prop_assert_eq!(s.coord_y(), y);
        prop_assert_eq!(s.state(), state);
        prop_assert_eq!(s.payload_meta(), meta);

        // Verify raw array LE mapping
        let arr = s.to_array();
        let mut recon = 0u128;
        for (i, &byte) in arr.iter().enumerate() {
            recon |= (byte as u128) << (i * 8);
        }

        let mut expected = 0u128;
        expected |= flags as u128;
        expected |= (x as u128) << 8;
        expected |= (y as u128) << (8 + 32);
        expected |= (state.to_bits() as u128) << (8 + 32 + 32);
        expected |= (meta as u128) << (8 + 32 + 32 + 2);

        prop_assert_eq!(recon, expected);
    }

    #[test]
    fn test_cross_boundary_fuzz(
        low in 0u8..16,
        mid in any::<u8>(),
        high in 0u8..16
    ) {
        let s = CrossBoundaryFuzz::default()
            .with_low(low)
            .with_mid(mid)
            .with_high(high);

        prop_assert_eq!(s.low(), low);
        prop_assert_eq!(s.mid(), mid);
        prop_assert_eq!(s.high(), high);

        // Manual verification of bit-packing
        let val = s.to_u16();
        let expected = (low as u16) | ((mid as u16) << 4) | ((high as u16) << 12);
        prop_assert_eq!(val, expected);
    }

    #[test]
    fn test_wide_fuzz16_roundtrip(
        start in any::<bool>(),
        large in any::<u128>(),
        end in 0u8..128
    ) {
        let mask_large = (!0u128) >> 8; // 120 bits
        let masked_large = large & mask_large;

        let s = WideFuzz16::default()
            .with_start(start)
            .with_large(masked_large)
            .with_end(end);

        prop_assert_eq!(s.start(), start);
        prop_assert_eq!(s.large(), masked_large);
        prop_assert_eq!(s.end(), end);
    }

    #[test]
    fn test_byteval_id24_fuzz(val in 0u32..(1u32 << 24)) {
        let id = FuzzId24::from_u32(val);
        prop_assert_eq!(id.value(), val);
        prop_assert_eq!(id.to_u32(), val);
        let arr = id.to_array();
        prop_assert_eq!(arr[0], (val & 0xFF) as u8);
        prop_assert_eq!(arr[1], ((val >> 8) & 0xFF) as u8);
        prop_assert_eq!(arr[2], ((val >> 16) & 0xFF) as u8);
    }

    #[test]
    #[allow(clippy::needless_range_loop)]
    fn test_byteval_id40_fuzz(val in 0u64..(1u64 << 40)) {
        let id = FuzzId40::from_u64(val);
        prop_assert_eq!(id.value(), val);
        prop_assert_eq!(id.to_u64(), val);
        let arr = id.to_array();
        for (i, &byte) in arr.iter().enumerate() {
            prop_assert_eq!(byte, ((val >> (i * 8)) & 0xFF) as u8);
        }
    }

    #[test]
    #[allow(clippy::needless_range_loop)]
    fn test_byteval_id56_fuzz(val in 0u64..(1u64 << 56)) {
        let id = FuzzId56::from_u64(val);
        prop_assert_eq!(id.value(), val);
        prop_assert_eq!(id.to_u64(), val);
        let arr = id.to_array();
        for (i, &byte) in arr.iter().enumerate() {
            prop_assert_eq!(byte, ((val >> (i * 8)) & 0xFF) as u8);
        }
    }

    #[test]
    #[allow(clippy::needless_range_loop)]
    fn test_byteval_id104_fuzz(val in any::<u128>()) {
        let mask = (!0u128) >> (128 - 104);
        let masked = val & mask;
        let id = FuzzId104::from_u128(masked);
        prop_assert_eq!(id.value(), masked);
        prop_assert_eq!(id.to_u128(), masked);
        let arr = id.to_array();
        for (i, &byte) in arr.iter().enumerate() {
            prop_assert_eq!(byte, ((masked >> (i * 8)) & 0xFF) as u8);
        }
    }

    #[test]
    fn test_field_isolation_fuzzed(
        initial in any::<u64>(),
        new_val in any::<u32>(),
    ) {
        let s = FuzzStruct::from_bits(initial);
        let s2 = s.with_c(new_val & 0xFFFFFF); // c is 24 bits
        prop_assert_eq!(s2.a(), s.a());
        prop_assert_eq!(s2.b(), s.b());
        prop_assert_eq!(s2.d(), s.d());
        prop_assert_eq!(s2.e(), s.e());
        prop_assert_eq!(s2.c(), new_val & 0xFFFFFF);
    }

    #[test]
    fn test_u16_storage_fuzz(
        v1 in 0u32..(1u32 << 24),
        v2 in 0u32..(1u32 << 24)
    ) {
        bytestruct! {
            struct U16Fuzzer([u16; 3]) {
                f1: u32 = 24,
                f2: u32 = 24,
            }
        }
        let s = U16Fuzzer::default().with_f1(v1).with_f2(v2);
        prop_assert_eq!(s.f1(), v1);
        prop_assert_eq!(s.f2(), v2);

        // Manual verification of u16 array packing
        let arr = s.to_array();
        let mut recon = 0u64;
        recon |= arr[0] as u64;
        recon |= (arr[1] as u64) << 16;
        recon |= (arr[2] as u64) << 32;

        let expected = (v1 as u64) | ((v2 as u64) << 24);
        prop_assert_eq!(recon, expected);
    }

    #[test]
    fn test_u32_storage_fuzz(
        v1 in any::<u32>(),
        v2 in any::<u32>()
    ) {
        bytestruct! {
            struct U32Fuzzer([u32; 2]) {
                f1: u32 = 32,
                f2: u32 = 32,
            }
        }
        let s = U32Fuzzer::default().with_f1(v1).with_f2(v2);
        prop_assert_eq!(s.f1(), v1);
        prop_assert_eq!(s.f2(), v2);
        prop_assert_eq!(s.to_array(), [v1, v2]);
    }

    #[test]
    fn test_from_bits_fresh_path_fuzz(val in any::<u64>()) {
        // Exercise the 8-element unroll path (64 bits total)
        bytestruct! {
            struct LargeFuzzer(8) {
                val: u64 = 64,
            }
        }
        let masked = val;
        let s = LargeFuzzer::from_bits(masked);
        prop_assert_eq!(s.to_bits(), masked);

        // Ensure initialized array matches manual construction
        let arr = s.to_array();
        for (i, &byte) in arr.iter().enumerate() {
            prop_assert_eq!(byte, ((masked >> (i * 8)) & 0xFF) as u8);
        }
    }
    #[test]
    fn test_u64_storage_fuzz(
        v1 in any::<u64>(),
        v2 in any::<u64>()
    ) {
        bytestruct! {
            struct U64Fuzzer([u64; 2]) {
                f1: u64 = 64,
                f2: u64 = 64,
            }
        }
        let s = U64Fuzzer::default().with_f1(v1).with_f2(v2);
        prop_assert_eq!(s.f1(), v1);
        prop_assert_eq!(s.f2(), v2);
        prop_assert_eq!(s.to_array(), [v1, v2]);
        prop_assert_eq!(s.to_bits(), (v1 as u128) | ((v2 as u128) << 64));
    }

    #[test]
    fn test_u128_storage_fuzz(val in any::<u128>()) {
        bytestruct! {
            struct U128Fuzzer([u128; 1]) {
                f1: u128 = 128,
            }
        }
        let s = U128Fuzzer::default().with_f1(val);
        prop_assert_eq!(s.f1(), val);
        prop_assert_eq!(s.to_array(), [val]);
        prop_assert_eq!(s.to_bits(), val);
    }

    #[test]
    fn test_u16_storage_128_fuzz(
        v1 in any::<u64>(),
        v2 in any::<u64>()
    ) {
        bytestruct! {
            struct U16WideFuzzer([u16; 8]) {
                f1: u64 = 64,
                f2: u64 = 64,
            }
        }
        let s = U16WideFuzzer::default().with_f1(v1).with_f2(v2);
        prop_assert_eq!(s.f1(), v1);
        prop_assert_eq!(s.f2(), v2);
        let arr = s.to_array();
        let mut recon = 0u128;
        for (i, &word) in arr.iter().enumerate() {
            recon |= (word as u128) << (i * 16);
        }
        prop_assert_eq!(recon, (v1 as u128) | ((v2 as u128) << 64));
    }

    #[test]
    fn test_u32_storage_128_fuzz(
        v1 in any::<u64>(),
        v2 in any::<u64>()
    ) {
        bytestruct! {
            struct U32WideFuzzer([u32; 4]) {
                f1: u64 = 64,
                f2: u64 = 64,
            }
        }
        let s = U32WideFuzzer::default().with_f1(v1).with_f2(v2);
        prop_assert_eq!(s.f1(), v1);
        prop_assert_eq!(s.f2(), v2);
        let arr = s.to_array();
        let mut recon = 0u128;
        for (i, &word) in arr.iter().enumerate() {
            recon |= (word as u128) << (i * 32);
        }
        prop_assert_eq!(recon, (v1 as u128) | ((v2 as u128) << 64));
    }

    #[test]
    fn test_u16_storage_odd_fuzz(
        v1 in 0u64..(1u64 << 48)
    ) {
        bytestruct! {
            struct U16OddFuzzer([u16; 3]) {
                f1: u64 = 48,
            }
        }
        let s = U16OddFuzzer::default().with_f1(v1);
        prop_assert_eq!(s.f1(), v1);
        let arr = s.to_array();
        let mut recon = 0u64;
        for (i, &word) in arr.iter().enumerate() {
            recon |= (word as u64) << (i * 16);
        }
        prop_assert_eq!(recon, v1);
    }

    #[test]
    fn test_u32_storage_odd_fuzz(
        v1 in any::<u128>()
    ) {
        bytestruct! {
            struct U32OddFuzzer([u32; 3]) {
                f1: u128 = 96,
            }
        }
        let mask = (!0u128) >> (128 - 96);
        let masked = v1 & mask;
        let s = U32OddFuzzer::default().with_f1(masked);
        prop_assert_eq!(s.f1(), masked);
        let arr = s.to_array();
        let mut recon = 0u128;
        for (i, &word) in arr.iter().enumerate() {
            recon |= (word as u128) << (i * 32);
        }
        prop_assert_eq!(recon, masked);
    }

    #[test]
    fn test_byteval_u16_odd_fuzz(val in 0u64..(1u64 << 48)) {
        byteval! { struct OddId(3, u16); }
        let id = OddId::from_u64(val);
        prop_assert_eq!(id.value(), val);
        prop_assert_eq!(id.to_u64(), val);
        let arr = id.to_array();
        for (i, &word) in arr.iter().enumerate() {
            prop_assert_eq!(word, ((val >> (i * 16)) & 0xFFFF) as u16);
        }
    }

    #[test]
    fn test_dense_bool_fuzz(bits in any::<u32>()) {
        let s = DenseFuzz::from_bits(bits);
        prop_assert_eq!(s.to_bits(), bits);
        prop_assert_eq!(s.b00(), (bits & 1) != 0);
        prop_assert_eq!(s.b01(), (bits & 2) != 0);
        prop_assert_eq!(s.b15(), (bits & (1 << 15)) != 0);
        prop_assert_eq!(s.b31(), (bits & (1 << 31)) != 0);
    }

    #[test]
    fn test_variety_byteval_fuzz(
        v48 in 0u64..(1u64 << 48),
        v96 in 0u128..(1u128 << 96)
    ) {
        let id48 = FuzzId48u16::from_u64(v48);
        prop_assert_eq!(id48.value(), v48);
        let arr48 = id48.to_array();
        for (i, &word) in arr48.iter().enumerate() {
            prop_assert_eq!(word, ((v48 >> (i * 16)) & 0xFFFF) as u16);
        }

        let id96 = FuzzId96u32::from_u128(v96);
        prop_assert_eq!(id96.value(), v96);
        let arr96 = id96.to_array();
        for (i, &word) in arr96.iter().enumerate() {
            prop_assert_eq!(word, ((v96 >> (i * 32)) & 0xFFFFFFFF) as u32);
        }
    }

    #[test]
    fn test_aligned_fuzzer_roundtrip(val in any::<u64>()) {
        let s = AlignedFuzzer::from_bits(val);
        prop_assert_eq!(s.val(), val);
        prop_assert_eq!(s.to_bits(), val);
        // Verify address is aligned to 8
        let addr = &s as *const _ as usize;
        prop_assert_eq!(addr % 8, 0);
    }

    #[test]
    fn test_safe_setters_overflow_fuzz(
        val in 0u32..(1u32 << 24),
        overflow_bit in 24u32..32u32
    ) {
        let mut id = FuzzId24::from_u32(val);
        let overflow_val = val | (1 << overflow_bit);

        // try_set should fail
        let res = id.try_set_value(overflow_val);
        prop_assert!(res.is_err());
        // Value should remain unchanged
        prop_assert_eq!(id.value(), val);

        // try_with should fail
        let res_with = id.try_with_value(overflow_val);
        prop_assert!(res_with.is_err());
    }

    #[test]
    fn test_mixed_storage_fuzzer_roundtrip(
        a in any::<u128>(),
        b in any::<u64>(),
    ) {
        let mask_a = (!0u128) >> (128 - 80);
        let mask_b = (!0u64) >> (64 - 48);
        let masked_a = a & mask_a;
        let masked_b = b & mask_b;

        let s = MixedStorageFuzzer::default()
            .with_a(masked_a)
            .with_b(masked_b);

        prop_assert_eq!(s.a(), masked_a);
        prop_assert_eq!(s.b(), masked_b);

        // Verify array-level packing
        let arr = s.to_array();
        let mut recon = 0u128;
        recon |= arr[0] as u128; // first 64 bits
        recon |= (arr[1] as u128) << 64; // next 64 bits

        let expected = (masked_a) | ((masked_b as u128) << 80);
        prop_assert_eq!(recon, expected);
    }
}