bitx 0.2.1

More ergonomic way to deal with bitfield-like struct.
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

#![allow(missing_docs)]

use bitx::bits;
use proptest::prelude::*;

bits! {
    pub struct FuzzHeader: 4.0 {
        0.0 pub flag: u1,
        0.1 pub status: u3,
        0.4 pub unaligned_cross: u12, // Crosses byte boundaries
        2   pub tail: u16,
    }
}

proptest! {
    #[test]
    fn fuzz_struct_reads(bytes in any::<[u8; 4]>()) {
        // Ensure constructors never panic
        let header = FuzzHeader::from_array(bytes);
        
        // Ensure slice reads never panic on valid sizes
        assert!(FuzzHeader::from_slice(&bytes).is_some());
        
        // Getters shouldn't panic and should stay within bit bounds
        let _flag = header.flag();
        let status = header.status();
        let unaligned = header.unaligned_cross();
        
        assert!(status <= 7); // u3 max is 7
        assert!(unaligned <= 4095); // u12 max is 4095
    }
}