hex_str 0.3.0

A library that helps handle hexadecimal strings
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

pub fn parse(a: u8, b: u8) -> Option<u8> {
    #[rustfmt::skip]
    static HEX_LSB: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,   1,   2,   3,   4,   5,   6,   7,   8,   9, -1, -1, -1, -1, -1, -1,
        -1,  10,  11,  12,  13,  14,  15,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  10,  11,  12,  13,  14,  15,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    #[rustfmt::skip]
    static HEX_MSB: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,  16,  32,  48,  64,  80,  96, 112, 128, 144, -1, -1, -1, -1, -1, -1,
        -1, 160, 176, 192, 208, 224, 240,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1, 160, 176, 192, 208, 224, 240,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    parse_(a, b, &HEX_LSB, &HEX_MSB)
}

pub fn parse_lower(a: u8, b: u8) -> Option<u8> {
    #[rustfmt::skip]
    static HEX_LSB_LOWER: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,   1,   2,   3,   4,   5,   6,   7,   8,   9, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  10,  11,  12,  13,  14,  15,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    #[rustfmt::skip]
    static HEX_MSB_LOWER: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,  16,  32,  48,  64,  80,  96, 112, 128, 144, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1, 160, 176, 192, 208, 224, 240,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    parse_(a, b, &HEX_LSB_LOWER, &HEX_MSB_LOWER)
}

pub fn parse_upper(a: u8, b: u8) -> Option<u8> {
    #[rustfmt::skip]
    static HEX_LSB_UPPER: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,   1,   2,   3,   4,   5,   6,   7,   8,   9, -1, -1, -1, -1, -1, -1,
        -1,  10,  11,  12,  13,  14,  15,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    #[rustfmt::skip]
    static HEX_MSB_UPPER: [i16; 256] = [
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
         0,  16,  32,  48,  64,  80,  96, 112, 128, 144, -1, -1, -1, -1, -1, -1,
        -1, 160, 176, 192, 208, 224, 240,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
        -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1, -1, -1, -1, -1, -1,
    ];

    parse_(a, b, &HEX_LSB_UPPER, &HEX_MSB_UPPER)
}

/// Safety: The values in lut's must be in range of `i16::MIN..256`
#[allow(clippy::inline_always, clippy::similar_names)]
#[inline(always)]
fn parse_(a: u8, b: u8, lut_lsb: &[i16; 256], lut_msb: &[i16; 256]) -> Option<u8> {
    let v = lut_msb[a as usize] | lut_lsb[b as usize];
    if v < 0 {
        None
    } else {
        #[allow(clippy::cast_possible_truncation)]
        #[allow(clippy::cast_sign_loss)]
        Some(v as u8)
    }
}

pub fn to_hex_lower(v: u8) -> [u8; 2] {
    let helper = |v: u8| -> u8 {
        match v {
            v @ 0..=9 => v + b'0',
            v @ 10..=15 => v - 10 + b'a',
            _ => unreachable!(),
        }
    };

    let a = (v & 0xf0) >> 4;
    let b = v & 0x0f;

    [helper(a), helper(b)]
}

pub fn to_hex_upper(v: u8) -> [u8; 2] {
    let helper = |v: u8| -> u8 {
        match v {
            v @ 0..=9 => v + b'0',
            v @ 10..=15 => v - 10 + b'A',
            _ => unreachable!(),
        }
    };

    let a = (v & 0xf0) >> 4;
    let b = v & 0x0f;

    [helper(a), helper(b)]
}

#[cfg(test)]
mod tests {
    fn to_lower(v: u8) -> Option<u8> {
        match v {
            0..=9 => Some(b'0' + v),
            10..=15 => Some(b'a' + v - 10),
            _ => None,
        }
    }

    fn to_upper(v: u8) -> Option<u8> {
        match v {
            0..=9 => Some(b'0' + v),
            10..=15 => Some(b'A' + v - 10),
            _ => None,
        }
    }

    #[test]
    fn parse() {
        for i in 0..16 {
            for j in 0..16 {
                let lower_a = to_lower(i).unwrap();
                let lower_b = to_lower(j).unwrap();

                let v = super::parse(lower_a, lower_b).unwrap();
                assert_eq!(v, i * 16 + j);

                let upper_a = to_upper(i).unwrap();
                let upper_b = to_upper(j).unwrap();

                let v = super::parse(upper_a, upper_b).unwrap();
                assert_eq!(v, i * 16 + j);
            }
        }
    }

    #[test]
    fn parse_lower() {
        for i in 0..16 {
            for j in 0..16 {
                let lower_a = to_lower(i).unwrap();
                let lower_b = to_lower(j).unwrap();

                let v = super::parse_lower(lower_a, lower_b).unwrap();
                assert_eq!(v, i * 16 + j);

                let upper_a = to_upper(i).unwrap();
                let upper_b = to_upper(j).unwrap();

                let v = super::parse_lower(upper_a, upper_b);
                if i < 10 && j < 10 {
                    // if we're dealing with `0..=9` then it'll parse correctly
                    assert_eq!(v.unwrap(), i * 16 + j);
                } else {
                    assert!(v.is_none());
                }
            }
        }
    }

    #[test]
    fn parse_upper() {
        for i in 0..16 {
            for j in 0..16 {
                let lower_a = to_lower(i).unwrap();
                let lower_b = to_lower(j).unwrap();

                let v = super::parse_upper(lower_a, lower_b);
                if i < 10 && j < 10 {
                    // if we're dealing with `0..=9` then it'll parse correctly
                    assert_eq!(v.unwrap(), i * 16 + j);
                } else {
                    assert!(v.is_none());
                }

                let upper_a = to_upper(i).unwrap();
                let upper_b = to_upper(j).unwrap();

                let v = super::parse_upper(upper_a, upper_b).unwrap();
                assert_eq!(v, i * 16 + j);
            }
        }
    }
}