mvbitfield 0.2.0

Generates types to work with bit-aligned fields.
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

use mvbitfield::prelude::*;

bitfield! {
    /// This enum has a doc comment.
    pub enum MyEnum: 2 {
        /// This variant has a doc comment.
        One = 1,
        Two,
        Three,
        Zero = 0,
    }

    /// This struct has a doc comment.
    #[msb_first]
    pub struct MyStruct: 16 {
        /// This field has a doc comment.
        pub high_bit: 1 as bool,
        pub next_two_bits: 2 as MyEnum,
        ..,
        pub a_low_bit: 1,
        pub last_three_bits: 3,
    }
}

#[bitint_literals]
#[test]
fn test_with_zeros() {
    assert_eq!(
        MyStruct::zero()
            .with_high_bit(false)
            .with_next_two_bits(MyEnum::Zero)
            .with_a_low_bit(0_U1)
            .with_last_three_bits(0_U3)
            .to_primitive(),
        0,
    );
}

#[bitint_literals]
#[test]
fn test_with_bits() {
    assert_eq!(
        MyStruct::zero().with_high_bit(true).to_primitive(),
        0b1_00_000000000_0_000,
    );
    assert_eq!(
        MyStruct::zero()
            .with_next_two_bits(MyEnum::Two)
            .to_primitive(),
        0b0_10_000000000_0_000,
    );
    assert_eq!(
        MyStruct::zero()
            .with_next_two_bits(MyEnum::One)
            .to_primitive(),
        0b0_01_000000000_0_000,
    );
    assert_eq!(
        MyStruct::zero().with_a_low_bit(1_U1).to_primitive(),
        0b0_00_000000000_1_000,
    );
    assert_eq!(
        MyStruct::zero().with_last_three_bits(4_U3).to_primitive(),
        0b0_00_000000000_0_100,
    );
    assert_eq!(
        MyStruct::zero().with_last_three_bits(2_U3).to_primitive(),
        0b0_00_000000000_0_010,
    );
    assert_eq!(
        MyStruct::zero().with_last_three_bits(1_U3).to_primitive(),
        0b0_00_000000000_0_001,
    );
}

#[bitint_literals]
#[test]
fn test_map() {
    assert_eq!(
        MyStruct::zero()
            .with_high_bit(true)
            .with_next_two_bits(MyEnum::Zero)
            .map_next_two_bits(|old| {
                assert_eq!(old, MyEnum::Zero);
                MyEnum::Three
            })
            .to_primitive(),
        0b1_11_000000000_0_000,
    );
    assert_eq!(
        MyStruct::zero()
            .with_high_bit(true)
            .with_next_two_bits(MyEnum::Three)
            .map_next_two_bits(|old| {
                assert_eq!(old, MyEnum::Three);
                MyEnum::Zero
            })
            .to_primitive(),
        0b1_00_000000000_0_000,
    );
}

#[bitint_literals]
#[test]
fn test_set() {
    let mut value = MyStruct::zero()
        .with_high_bit(true)
        .with_next_two_bits(MyEnum::Zero);
    value.set_next_two_bits(MyEnum::Three);
    assert_eq!(value.to_primitive(), 0b1_11_000000000_0_000);

    value.set_next_two_bits(MyEnum::Zero);
    assert_eq!(value.to_primitive(), 0b1_00_000000000_0_000);
}

#[bitint_literals]
#[test]
fn test_replace() {
    let mut value = MyStruct::zero()
        .with_high_bit(true)
        .with_next_two_bits(MyEnum::Zero);
    assert_eq!(value.replace_next_two_bits(MyEnum::Three), MyEnum::Zero);
    assert_eq!(value.to_primitive(), 0b1_11_000000000_0_000);

    assert_eq!(value.replace_next_two_bits(MyEnum::Zero), MyEnum::Three);
    assert_eq!(value.to_primitive(), 0b1_00_000000000_0_000);
}

#[bitint_literals]
#[test]
fn test_update() {
    let mut value = MyStruct::zero()
        .with_high_bit(true)
        .with_next_two_bits(MyEnum::Zero);
    assert_eq!(
        value.update_next_two_bits(|old| {
            assert_eq!(old, MyEnum::Zero);
            MyEnum::Three
        }),
        MyEnum::Zero,
    );
    assert_eq!(value.to_primitive(), 0b1_11_000000000_0_000);

    assert_eq!(
        value.update_next_two_bits(|old| {
            assert_eq!(old, MyEnum::Three);
            MyEnum::Zero
        }),
        MyEnum::Three,
    );
    assert_eq!(value.to_primitive(), 0b1_00_000000000_0_000);
}