hex-simd 0.8.0

SIMD-accelerated hex encoding and decoding
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

use hex_simd::{AsOut, AsciiCase};

use core::mem::MaybeUninit;

fn rand_bytes(n: usize) -> Vec<u8> {
    use rand::RngCore;
    let mut bytes = vec![0u8; n];
    rand::thread_rng().fill_bytes(&mut bytes);
    bytes
}

#[cfg(miri)]
use std::io::Write as _;

macro_rules! dbgmsg {
    ($($fmt:tt)*) => {
        // println!($($fmt)*);
        // #[cfg(miri)]
        // std::io::stdout().flush().unwrap();
    };
}

#[cfg_attr(not(target_arch = "wasm32"), test)]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
fn as_str() {
    let src = "hello";
    let mut buf = [MaybeUninit::<u8>::uninit(); 10];
    let ans = hex_simd::encode_as_str(src.as_bytes(), buf.as_mut_slice().as_out(), AsciiCase::Lower);
    assert_eq!(ans, "68656c6c6f");
}

#[cfg(feature = "alloc")]
#[cfg_attr(not(target_arch = "wasm32"), test)]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
fn allocation() {
    {
        let src = "hello";

        let ans: String = hex_simd::encode_type(src, AsciiCase::Lower);
        assert_eq!(&*ans, "68656c6c6f");

        let ans: Vec<u8> = hex_simd::decode_type(ans).unwrap();
        assert_eq!(&*ans, src.as_bytes());
    }

    {
        let src = [1, 2, 3];
        let prefix = "0x";

        let mut encode_buf = prefix.to_owned();
        hex_simd::encode_append(src, &mut encode_buf, AsciiCase::Lower);

        assert_eq!(encode_buf, format!("{prefix}010203"));

        let mut decode_buf = b"123".to_vec();
        let src = &encode_buf[prefix.len()..];
        hex_simd::decode_append(src, &mut decode_buf).unwrap();

        assert_eq!(decode_buf, b"123\x01\x02\x03");
    }
}

#[cfg_attr(not(target_arch = "wasm32"), test)]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
fn random() {
    let ok_cases: Vec<Vec<u8>> = {
        let mut ans = Vec::new();

        for n in 0..128usize {
            dbgmsg!("generating ok case n = {}", n);

            let iter = (0..16).cycle().take(n).map(|x| char::from_digit(x, 16).unwrap() as u8);
            ans.push(iter.collect());
        }

        ans
    };

    let err_cases: Vec<Vec<u8>> = {
        vec![
            vec![0],
            vec![b'0', 0],
            vec![b'a', b'f', 0],
            vec![b'a', b'0', b'c', 0],
            vec![b'a', b'0', b'c', b'1', 0],
        ]
    };

    macro_rules! test_decode_encode {
        ($src: expr, $case: expr) => {{
            let mut decode_buf = vec![0; $src.len() / 2];
            let mut encode_buf = vec![0; $src.len()];
            let decode_buf = hex_simd::decode($src, decode_buf.as_out()).unwrap();
            let encode_buf = hex_simd::encode(decode_buf, encode_buf.as_out(), $case);
            assert_eq!(encode_buf, $src);
        }};
    }

    macro_rules! test_decode_inplace_encode {
        ($src: expr, $case: expr) => {{
            let mut decode_buf = $src.to_owned();
            let mut encode_buf = vec![0; $src.len()];
            let decode_buf = hex_simd::decode_inplace(&mut decode_buf).unwrap();
            let encode_buf = hex_simd::encode(decode_buf, encode_buf.as_out(), $case);
            assert_eq!(encode_buf, $src);
        }};
    }

    macro_rules! test_encode_decode {
        ($src: expr, $case: expr) => {{
            let mut encode_buf = vec![0; $src.len() * 2];
            let mut decode_buf = vec![0; $src.len()];
            let encode_buf = hex_simd::encode($src, encode_buf.as_out(), $case);
            let decode_buf = hex_simd::decode(encode_buf, decode_buf.as_out()).unwrap();
            assert_eq!(decode_buf, $src);
        }};
    }

    macro_rules! test_encode_decode_inplace {
        ($src: expr, $case: expr) => {{
            let mut encode_buf = vec![0; $src.len() * 2];
            let encode_buf = hex_simd::encode($src, encode_buf.as_out(), $case);
            let decode_buf = hex_simd::decode_inplace(encode_buf).unwrap();
            assert_eq!(decode_buf, $src);
        }};
    }

    for (_, src) in ok_cases.iter().enumerate() {
        // dbgmsg!("ok case {}", i + 1);
        assert!(hex_simd::check(src).is_ok());
        if src.len() % 2 == 0 {
            test_decode_encode!(src, AsciiCase::Lower);
            test_decode_inplace_encode!(src, AsciiCase::Lower);
        } else {
            test_encode_decode!(src, AsciiCase::Upper);
            test_encode_decode_inplace!(src, AsciiCase::Lower);
        }
    }

    for (_, src) in err_cases.iter().enumerate() {
        // dbgmsg!("err case {}", i + 1);
        assert!(hex_simd::check(src).is_err());
        let mut buf = vec![0; src.len() / 2];
        assert!(hex_simd::decode(src, buf.as_out()).is_err(), "src = {src:?}");
    }

    for n in 0..128 {
        dbgmsg!("rand case n = {}", n);
        let bytes = rand_bytes(n);
        let src = bytes.as_slice();
        test_encode_decode!(src, AsciiCase::Lower);
        test_encode_decode_inplace!(src, AsciiCase::Upper);
    }
}