bitfields 2.0.6

Macro for for generating bitfields from structs and enum bitflags for defining packed binary schemas in low-level systems (e.g. embedded development or emulators)
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

use bitfields::bitfield;

#[derive(Debug, PartialEq, Clone, Copy)]
struct Color {
    red: u8,
    green: u8,
    blue: u8,
}

impl Color {
    /// Convert raw bits into a `Color`.
    const fn from_bits(bits: u8) -> Self {
        Self {
            red: bits & 0b0000_0111,
            green: (bits >> 3) & 0b0000_0111,
            blue: (bits >> 6) & 0b0000_0011,
        }
    }

    /// Pack a `Color` back into bits.
    const fn into_bits(self) -> u8 {
        (self.red & 0b0000_0111)
            | ((self.green & 0b0000_0111) << 3)
            | ((self.blue & 0b0000_0011) << 6)
    }
}

const DEFAULT_COLOR: Color = Color {
    red: 5,
    green: 3,
    blue: 1,
};

#[bitfield(u16)]
struct FrameConfig {
    #[bits(8, default = DEFAULT_COLOR)]
    background: Color,

    #[bits(8)]
    foreground: Color,
}

fn main() {
    let cfg = FrameConfig::default();

    assert_eq!(cfg.background(), DEFAULT_COLOR);
    assert_eq!(
        cfg.foreground(),
        Color {
            red: 0,
            green: 0,
            blue: 0
        }
    );
}