modular-bitfield 0.13.1

Easily define bitfield types with modular building blocks.
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

//! Tests for `#[derive(Debug)]`

extern crate alloc;
use alloc::format;
use modular_bitfield::prelude::*;

#[test]
fn print_invalid_bits() {
    #[derive(Specifier, Debug)]
    #[bits = 2]
    pub enum Status {
        Green = 0,
        Yellow = 1,
        Red = 2, // 0x11 (= 3) is undefined here for Status!
    }

    #[bitfield]
    #[derive(Debug)]
    pub struct DataPackage {
        status: Status,
        contents: B4,
        is_alive: bool,
        is_received: bool,
    }

    let package = DataPackage::from_bytes([0b0101_1011]);
    assert_eq!(
        format!("{package:?}"),
        "DataPackage { status: InvalidBitPattern { invalid_bytes: 3 }, contents: 6, is_alive: true, is_received: false }",
    );
    assert_eq!(
        format!("{package:#X?}"),
        "DataPackage {\n    \
            status: InvalidBitPattern {\n        \
                invalid_bytes: 0x3,\n    \
            },\n    \
            contents: 0x6,\n    \
            is_alive: true,\n    \
            is_received: false,\n\
        }",
    );
}

#[test]
fn respects_other_derives() {
    #[bitfield]
    #[derive(Debug, Clone, PartialEq, Eq)]
    pub struct Color {
        r: B6,
        g: B6,
        b: B6,
        a: B6,
    }

    let color1 = Color::new().with_r(63).with_g(32).with_b(16).with_a(8);
    let color2 = color1.clone();
    assert_eq!(color1, color2);
    assert_eq!(format!("{color1:?}"), "Color { r: 63, g: 32, b: 16, a: 8 }",);
    assert_eq!(
        format!("{color2:#x?}"),
        "Color {\n    r: 0x3f,\n    g: 0x20,\n    b: 0x10,\n    a: 0x8,\n}",
    );
}

#[test]
fn valid_use_2() {
    #[derive(Specifier, Debug)]
    pub enum Status {
        Green,
        Yellow,
        Red,
        None,
    }

    #[bitfield]
    #[derive(Debug)]
    pub struct DataPackage {
        status: Status,
        contents: B60,
        is_alive: bool,
        is_received: bool,
    }

    let package = DataPackage::new()
        .with_status(Status::Green)
        .with_contents(0xC0DE_CAFE)
        .with_is_alive(true)
        .with_is_received(false);
    assert_eq!(
        format!("{package:?}"),
        "DataPackage { status: Green, contents: 3235826430, is_alive: true, is_received: false }",
    );
    assert_eq!(
        format!("{package:#X?}"),
        "DataPackage {\n    status: Green,\n    contents: 0xC0DECAFE,\n    is_alive: true,\n    is_received: false,\n}",
    );
}

#[test]
fn valid_use_specifier() {
    #[bitfield(filled = false)] // Requires just 4 bits!
    #[derive(Specifier, Debug)]
    pub struct Header {
        status: B2,
        is_alive: bool,
        is_received: bool,
    }

    let header = Header::new()
        .with_status(1)
        .with_is_alive(true)
        .with_is_received(false);
    assert_eq!(
        format!("{header:?}"),
        "Header { status: 1, is_alive: true, is_received: false }",
    );
    assert_eq!(
        format!("{header:#X?}"),
        "Header {\n    status: 0x1,\n    is_alive: true,\n    is_received: false,\n}",
    );
}

#[test]
fn valid_use() {
    #[bitfield]
    #[derive(Debug)]
    pub struct Color {
        r: B6,
        g: B6,
        b: B6,
        a: B6,
    }

    let color = Color::new().with_r(63).with_g(32).with_b(16).with_a(8);
    assert_eq!(format!("{color:?}"), "Color { r: 63, g: 32, b: 16, a: 8 }",);
    assert_eq!(
        format!("{color:#x?}"),
        "Color {\n    r: 0x3f,\n    g: 0x20,\n    b: 0x10,\n    a: 0x8,\n}",
    );
}

#[test]
fn valid_use_tuple() {
    #[bitfield]
    #[derive(Debug)]
    pub struct Color(B6, B6, B6, B6);

    let color = Color::new().with_0(63).with_1(32).with_2(16).with_3(8);
    assert_eq!(format!("{color:?}"), "Color(63, 32, 16, 8)",);
    assert_eq!(
        format!("{color:#x?}"),
        "Color(\n    0x3f,\n    0x20,\n    0x10,\n    0x8,\n)",
    );
}