bitable 0.1.0

An all-const, compile-time checked, safe bit handling library with zero runtime overhead
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

//! # Test suite
//! 

// ---------------------------------------------------------------------------
// Testing context (shared between runtime and compile-time test suites)
// ---------------------------------------------------------------------------

pub mod context;

// ---------------------------------------------------------------------------
// Core helper functions
// ---------------------------------------------------------------------------

mod core_helper_functions {
    // use super::*;
    // #[test]
    // #[should_panic]
    // fn field_mask_32() {
    //     let mask: u32 = field_mask(32);
    //     println!("*** Mask: {}", mask)
    // }
}

// ---------------------------------------------------------------------------
// Core target types
// ---------------------------------------------------------------------------

mod core_target_u8 {
    use super::context::*;

    // is_set(u8)
    #[test]
    fn u8bit_is_set() {
        let yes: u8 = 0b1 << U8_OFFSET;
        assert_eq!(true, U8_BIT.is_set(&yes));
    }
    #[test]
    fn u8bit_is_not_set() {
        let no: u8 = 0;
        assert_eq!(false, U8_BIT.is_set(&no));
    }

    // #[test]
    // #[should_panic(expected = "Bit offset too large for this set of bits")]
    // fn u16bit_is_set() {
    //     let dc: u8 = 0;
    //     U16BIT.is_set(&dc);
    // }
    // is_clr(u8)
    // #[test]
    // fn u8bit_is_clr() {
    //     let yes: u8 = 0;
    //     assert_eq!(true, U8_BIT.is_clr(&yes));
    // }
    // #[test]
    // fn u8bit_is_not_clr() {
    //     let no: u8 = 0b1 << U8_OFFSET;
    //     assert_eq!(false, U8_BIT.is_clr(&no));
    // }
    // #[test]
    // #[should_panic(expected = "Bit offset too large for this set of bits")]
    // fn u16bit_is_clr() {
    //     let dc: u8 = 0;
    //     U16BIT.is_set(&dc);
    // }
}

mod core_target_u16 {
    use super::context::*;

    // is_set(u16)
    #[test]
    fn u16bit_is_set() {
        let yes: u16 = 0b1 << U8_OFFSET;
        assert_eq!(true, U8_BIT.is_set(&yes));
    }
    #[test]
    fn u16bit_is_not_set() {
        let no: u16 = 0;
        assert_eq!(false, U8_BIT.is_set(&no));
    }
    // #[test]
    // #[should_panic(expected = "Bit offset too large for this set of bits")]
    // fn u32bit_is_set() {
    //     let dc: u16 = 0;
    //     U32BIT.is_set(&dc);
    // }
    // is_clr(u16)
    #[test]
    fn u16bit_is_clr() {
        let yes: u8 = 0;
        assert_eq!(true, U8_BIT.is_clr(&yes));
    }
    #[test]
    fn u16bit_is_not_clr() {
        let no: u8 = 0b1 << U8_OFFSET;
        assert_eq!(false, U8_BIT.is_clr(&no));
    }
    // #[test]
    // #[should_panic(expected = "Bit offset too large for this set of bits")]
    // fn u32bit_is_clr() {
    //     let dc: u8 = 0;
    //     U16BIT.is_set(&dc);
    // }
    #[test]
    fn u32field_0_32_in_u8array_read() {
        let no: [u8; 5] = [0x12, 0x34, 0x56, 0x78, 0x9a];
        let f = Field::<0, 32>::new();
        let s : u32 = f.read(&no);
        assert_eq!(0x12345678, s);
    }
    #[test]
    fn u32field_0_32_in_u8array_read_at_0() {
        let no: [u8; 5] = [0x12, 0x34, 0x56, 0x78, 0x9a];
        let f = Field::<0, 32>::new();
        let s0 : u32 = f.read_at(&no, 0);
        assert_eq!(0x12345678, s0);
    }
    #[test]
    fn u32field_0_32_in_u8array_read_at_1() {
        let no: [u8; 5] = [0x12, 0x34, 0x56, 0x78, 0x9a];
        let f = Field::<0, 32>::new();
        let s1 : u32 = f.read_at(&no, 1);
        assert_eq!(0x3456789a, s1);
    }
    #[test]
    fn u32field_8_24_in_u8array_read_at_1() {
        let no: [u8; 5] = [0x12, 0x34, 0x56, 0x78, 0x9a];
        let f = Field::<8, 24>::new();
        let s0 : u32 = f.read_at(&no, 1);
        assert_eq!(0x345678, s0);
    }
    #[test]
    fn u32field_4_20_in_u8array_read_at_1() {
        let no: [u8; 5] = [0x12, 0x34, 0x56, 0x78, 0x9a];
        let f = Field::<4, 20>::new();
        let s0 : u32 = f.read_at(&no, 1);
        assert_eq!(0x56789, s0);
    }
}

// ---------------------------------------------------------------------------
// Conversion between core types
// ---------------------------------------------------------------------------

mod basic_bit_and_bitmasks {
    use super::context::*;

    const BITMASK_U32: Mask = Mask::new(1 << U8_OFFSET);

    // #[test]
    // fn mask_from_bit() {
    //     assert_eq!( (1 << U8_OFFSET) as u32, U8_BIT.mask().into() );
    // }
    // #[test]
    // #[should_panic(expected = "Bit offset too large for this set of bits")]
    // fn bit_offset_too_big() {
    //     let bit = Bit::new(32);
    //     let _ = bit.mask();
    // }

    // #[test]
    // fn mask_from_bitfield() {
    //     assert_eq!( (((1 << LENGTH) - 1) << U8_OFFSET) as u32, BITFIELD.mask().into() );
    // }

    // #[test]
    // fn bitmask_u32_from_bit() {
    //     assert_eq!( BITMASK_U32, Mask::<u32>::from(U8_BIT) );
    // }
    // #[test]
    // fn bit_into_bitmask_u32() {
    //     assert_eq!( BITMASK_U32, U8_BIT.into() );
    // }

    #[test]
    fn u32_from_bitmask_u32() {
        assert_eq!( 1 << U8_OFFSET, u32::from(BITMASK_U32) );
    }
    // #[test]
    // fn bitmask_u32_into_u32() {
    //     assert_eq!( (1 << U8_OFFSET) as u32, BITMASK_U32.into() );
    // }
}

// ---------------------------------------------------------------------------
// core::ops implementations
// ---------------------------------------------------------------------------

mod bit_deref_tests {
    // use super::context::*;

    // fn u32_param(p: u32) -> u32 { p }
    
    // #[test]
    // fn test_deref() {
    //     assert_eq!(*U8_BIT, U8_OFFSET);
    // }
}

mod bit_add_tests {
    // use super::context::*;

    // #[test]
    // fn test_add_u32_and_bit() {
    //     let mut cnt: u32 = 1;
    //     cnt = cnt + U8_BIT;
    //     assert_eq!(cnt, 1 + U8_OFFSET as u32);

    //     // let mut cnt: u32 = 1;
    //     // cnt = (BIT + cnt).into();
    //     // assert_eq!(cnt, 0b1 << (1 + U8_OFFSET as u32));

    //     // let mut bit = Bit::new(U8_OFFSET);
    //     // let cnt: u32 = 0;
    //     // bit = bit + cnt;
    //     // assert_eq!((0b1 << U8_OFFSET) as u32, bit.into());
    // }
}