splitbits 0.1.2

Concise bit field extraction
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

extern crate splitbits;

use splitbits::{replacebits, replacehex};
use ux::{u4, u28};

#[test]
fn replace() {
    let a = 0b101u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(0b1001_1010_1100_1111u16, "aaab bbbb .d.. cccc");
    assert_eq!(result,        0b1010_0001_1000_0101u16);
}

#[test]
fn replace_var() {
    let var = 0b1001_1010_1100_1111u16;
    let a = 0b101u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(var, "aaab bbbb .d.. cccc");
    assert_eq!(result,        0b1010_0001_1000_0101u16);
}

#[test]
fn replace_with_literal() {
    let a = 0b101u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(0b1001_1010_1100_1111u16, "aaab bbbb 0d11 cccc");
    assert_eq!(result,        0b1010_0001_0011_0101u16);
}

#[test]
fn replace_segments() {
    let a = 0b101u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = true;
    let result = replacebits!(0b1001_1010_1100_1111u16, "aabb bbab .c.. ccdc");
    assert_eq!(result,        0b1000_0011_1000_1011u16);
}

#[test]
fn replace_too_big() {
    let a = 0b110u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(0b0001_1010_1100_1111u16, ".aab bbbb .d.. cccc");
    assert_eq!(result,        0b0100_0001_1000_0101u16);
}

// Same behavior as default.
#[test]
fn replace_too_big_truncate() {
    let a = 0b110u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(overflow=truncate, 0b0001_1010_1100_1111u16, ".aab bbbb .d.. cccc");
    assert_eq!(result,                           0b0100_0001_1000_0101u16);
}

#[test]
#[should_panic(expected = "Variable a is too big for its location in the template. 0b110 > 0b11")]
fn replace_too_big_panic() {
    let a = 0b110u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let _ = replacebits!(overflow=panic, 0b0001_1010_1100_1111u16, ".aab bbbb .d.. cccc");
}

#[test]
fn replace_too_big_saturate() {
    let a = 0b110u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(overflow=saturate, 0b0001_1010_1100_1111u16, ".aab bbbb .d.. cccc");
    assert_eq!(result,                           0b0110_0001_1000_0101u16);
}

#[test]
fn replace_too_big_corrupt() {
    let a = 0b1101u16;
    let b = 0b00001u8;
    let c = 0b0101u128;
    let d = false;
    let result = replacebits!(overflow=corrupt, 0b0001_1010_1100_1111u16, ".aab bbbb .d.. cccc");
    assert_eq!(result,                          0b1010_0001_1000_0101u16);
}

#[test]
fn replacehex_ux() {
    let a = u4::new(0xE);
    let c: u8 = 0x2A;
    let b = u28::new(0x90210AB);
    let result = replacehex!(0xABCD_EF01_2345_6789, "0a.. cc.b bbbb bb1D");
    assert_eq!(result,       0x0ECD_2A09_0210_AB1Du64);
}