faster-hex

![License] ![crate-badge]

This program implements hex encoding a slice into a predetermined destination using various different instruction sets.

Benchmark

Running

Runs benchmark cargo bench

Results

Machine: MacBook Pro (Early 2015) (2.7 GHz Intel Core i5)

Rust: rustc 1.31.0 (abe02cefd 2018-12-04)

Compare with hex:

• Encoding ~10x over
• Decoding ~10x over

Compare with rustc-hex:

• Encoding ~2.5x over
• Decoding ~7x over

Examples

Encode to hex

```rust use fasterhex::hexstring;

let result = hexstring(b"Hello world!"); asserteq!(result, "48656c6c6f20776f726c6421"); Encode to upper case hex rust use fasterhex::hexstring_upper;

let result = hexstringupper(b"Hello world!"); assert_eq!(result, "48656C6C6F20776F726C6421"); ```

Decode ```rust use fasterhex::hexdecode;

let src = b"48656c6c6f20776f726c6421"; let mut dst = vec![0; src.len() / 2]; hexdecode(src, &mut dst).unwrap(); asserteq!(dst, b"Hello world!"); Decode with case check rust use fasterhex::{hexdecodewithcase, CheckCase};

let src = b"48656c6c6f20776f726c6421"; let mut dst = vec![0; src.len() / 2];

assert!(hexdecodewithcase(src, &mut dst, CheckCase::Lower).isok()); assert_eq!(dst, b"Hello world!");

assert!(hexdecodewithcase(src, &mut dst, CheckCase::None).isok()); assert_eq!(dst, b"Hello world!");

assert!(hexdecodewithcase(src, &mut dst, CheckCase::Upper).iserr()); ```

Serde feature ```rust

use serde::{Deserialize, Serialize};

[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]

struct Simple { #[serde(with = "fasterhex")] foo: Vec, #[serde(with = "fasterhex::nopfx_lowercase")] bar: Vec, } ```

Notice

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

MINOR version when make incompatible API changes before 1.0.0.

License

This project is licensed under the MIT license.

Third party software

This product includes copies and modifications of software developed by third parties:

• src/encode.rs is based on stdsimd, licensed under the MIT license or the Apache License (Version 2.0).
• src/decode.rs avx2 decode is modified from fast-hex

See the source code files for more details.

Copies of third party licenses can be found in LICENSE-THIRD-PARTY.