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

//! Tests for `#[bitfield(bits = N)]`

use modular_bitfield::prelude::*;

#[test]
fn bits_non_filled_1() {
    #[bitfield(bits = 32, filled = false)]
    #[derive(Specifier)]
    pub struct SignIntegerShort {
        sign: bool,
        value: B7,
    }

    assert_eq!(<SignIntegerShort as Specifier>::BITS, 32);
}

#[test]
fn bits_non_filled_2() {
    #[bitfield(bits = 32, filled = false)]
    #[derive(Specifier)]
    pub struct SignIntegerLong {
        sign: bool,
        value: B30,
    }

    assert_eq!(<SignIntegerLong as Specifier>::BITS, 32);
}

#[test]
fn complex_use_case() {
    #[derive(Specifier)]
    #[bits = 2]
    pub enum Status {
        Red,
        Green,
        Yellow,
    }

    #[bitfield(bits = 4)]
    #[derive(Specifier)]
    pub struct Header {
        is_compact: bool,
        is_secure: bool,
        #[bits = 2]
        pre_status: Status,
    }

    #[bitfield(bits = 16, bytes = 2, filled = false)]
    #[derive(Specifier)]
    pub struct PackedData {
        #[bits = 4]
        header: Header,
        body: B9,
        #[bits = 2]
        status: Status,
    }

    assert_eq!(<Status as Specifier>::BITS, 2);
    assert_eq!(<Header as Specifier>::BITS, 4);
    assert_eq!(<PackedData as Specifier>::BITS, 16);
}

#[test]
fn low_bits_filled() {
    #[bitfield(bits = 4)]
    #[derive(Specifier)]
    pub struct Header {
        is_compact: bool,
        is_secure: bool,
        #[bits = 2]
        pre_status: B2,
    }

    assert_eq!(<Header as Specifier>::BITS, 4);
}

#[test]
fn valid_use_1() {
    #[bitfield(bits = 32)]
    pub struct SignInteger {
        sign: bool,
        value: B31,
    }
}

#[test]
fn valid_use_2() {
    #[bitfield(bits = 32)]
    #[repr(u32)]
    pub struct SignInteger {
        sign: bool,
        value: B31,
    }
}

#[test]
fn valid_use_3() {
    #[bitfield(bits = 32, bytes = 4)]
    #[repr(u32)]
    pub struct SignInteger {
        sign: bool,
        value: B31,
    }
}

#[test]
fn valid_use_4() {
    #[bitfield(bits = 32, bytes = 4)]
    #[repr(u32)]
    #[derive(Debug, Specifier)]
    pub struct SignInteger {
        sign: bool,
        value: B31,
    }
}