devela 0.28.0

A development substrate of coherence.
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

// devela::data::codec::bit::bin::field::tests

#![allow(unused)]

use super::*;

bitfield! {
    struct TestBitfield(u16) {
        a = 0;
        b = 1..=3;
        c = 4..=7;
        D = 8..=15; // check uppercase field
    }
}
bitfield! {
    struct TestBitfield2(u16) {
        // no 0
        b = 1..=3;
        // no 4
        c = 5..=6;
    }
}

#[test]
fn bitfield_metadata() {
    assert_eq!(TestBitfield::all().bits(), 0b_1111_1111_1111_1111);
    assert!(TestBitfield::all().is_full());
    assert!(!TestBitfield::new().is_full());
    assert_eq!(TestBitfield::_BITFIELD_BIT_SIZE, 16);

    assert_eq!(TestBitfield2::all().bits(), 0b_0110_1110);
    assert!(TestBitfield2::all().is_full());
    assert!(!TestBitfield2::new().is_full());
    assert_eq!(TestBitfield2::_BITFIELD_BIT_SIZE, 7);
}

#[test]
fn field_metadata() {
    assert_eq![1, TestBitfield::_b_START];
    assert_eq![3, TestBitfield::_b_END];
    assert_eq![3, TestBitfield::_b_WIDTH];
    assert_eq![0b0000_1110, TestBitfield::b.bits()];
    assert_eq![0b0000_0111, TestBitfield::_b_MAX];

    assert_eq![4, TestBitfield::_c_START];
    assert_eq![7, TestBitfield::_c_END];
    assert_eq![4, TestBitfield::_c_WIDTH];
    assert_eq![0b1111_0000, TestBitfield::c.bits()];
    assert_eq![0b0000_1111, TestBitfield::_c_MAX];
}

#[test]
fn bitfield_gets_and_sets_fields() {
    let f = TestBitfield::new().with_a(1).with_b(0b101).with_c(0b1100).with_d(0xAB);
    assert_eq!(f.get_a(), 1);
    assert_eq!(f.get_b(), 0b101);
    assert_eq!(f.get_c(), 0b1100);
    assert_eq!(f.get_d(), 0xAB);
    assert_eq!(TestBitfield::a.bits(), 0b0000_0000_0000_0001);
    assert_eq!(TestBitfield::b.bits(), 0b0000_0000_0000_1110);
    assert_eq!(TestBitfield::c.bits(), 0b0000_0000_1111_0000);
    assert_eq!(TestBitfield::D.bits(), 0b1111_1111_0000_0000);
}
#[test]
fn bitfield_mutates_fields() {
    let mut f = TestBitfield::new();
    f.set_b(0b111);
    assert_eq!(f.get_b(), 0b111);
    f.set_b(0b010);
    assert_eq!(f.get_b(), 0b010);
    f.clear_b();
    assert_eq!(f.get_b(), 0);
    assert_eq!(f.bits(), 0);
}
#[test]
fn bitfield_overwrites_only_target_range() {
    let f = TestBitfield::new().with_b(0b111).with_c(0b1111).with_b(0b001);
    assert_eq!(f.get_b(), 0b001);
    assert_eq!(f.get_c(), 0b1111);
}
#[test]
fn bitfield_checked_operations_validate_capacity() {
    crate::bitfield! {
        struct CheckedHeader(u16) {
            KIND = 0..=3;
            TWO  = 4..=5;
            FLAG = 6;
        }
    }
    let mut h = CheckedHeader::new();

    assert!(h.try_set_kind(15).is_ok());
    assert_eq!(h.get_kind(), 15);
    assert!(h.try_set_kind(16).is_err());
    assert_eq!(h.get_kind(), 15);

    assert!(h.try_set_two(3).is_ok());
    assert_eq!(h.get_two(), 3);
    assert!(h.try_set_two(4).is_err());
    assert_eq!(h.get_two(), 3);

    assert!(h.try_set_flag(1).is_ok());
    assert_eq!(h.get_flag(), 1);
    assert!(h.try_set_flag(2).is_err());
    assert_eq!(h.get_flag(), 1);

    assert!(CheckedHeader::new().try_with_kind(15).is_ok());
    assert!(CheckedHeader::new().try_with_kind(16).is_err());
    assert!(CheckedHeader::new().try_with_two(3).is_ok());
    assert!(CheckedHeader::new().try_with_two(4).is_err());
}
#[test]
fn bitfield_uppercase_fields_generate_lowercase_methods() {
    crate::bitfield! {
        struct CaseHeader(u8) {
            KIND = 0..=3;
            IS_SET = 4;
        }
    }
    let h = CaseHeader::new().with_kind(7).with_is_set(1);
    assert_eq!(h.get_kind(), 7);
    assert_eq!(h.get_is_set(), 1);
}

// The following tests intentionally should not compile
/**
```compile_fail
bitfield! { struct BitfieldOverlap(u16) { a = 1..=3; b = 2..=4; } }
```
```compile_fail
bitfield! { struct BitfieldOverlap(u16) { a = 1..=3; b = 3; } }
```
**/
fn overlapping_fields() {}

/**
```compile_fail
bitfield! { struct BitfieldReversedStartEnd(u16) { A = 0; B = 3..=2; } }
```
```compile_fail
bitfield! { struct BitfieldRangeOverflow(u16) { A = 0; B = 3..=17; } }
```
**/
fn incorrect_field_ranges() {}