Crate hex_conservative

Hex encoding and decoding.

General purpose hex encoding/decoding library with a conservative MSRV and dependency policy.

Basic Usage

// Use the `package` key to improve import ergonomics (`hex` instead of `hex-conservative`).
// hex = { package = "hex-conservative", version = "*" }
use hex::{DisplayHex, FromHex};

// Decode an arbitrary length hex string into a vector.
let v = Vec::from_hex("deadbeef").expect("valid hex digits");
// Or a known length hex string into a fixed size array.
let a = <[u8; 4]>::from_hex("deadbeef").expect("valid length and valid hex digits");

// We support `LowerHex` and `UpperHex` out of the box for `[u8]` slices.
println!("An array as lower hex: {:x}", a.as_hex());
// And for vecs since `Vec` derefs to byte slice.
println!("A vector as upper hex: {:X}", v.as_hex());

// Allocate a new string (also `to_upper_hex_string`).
let s = v.to_lower_hex_string();

// Please note, mixed case strings will still parse successfully but we only
// support displaying hex in a single case.
assert_eq!(
    Vec::from_hex("dEaDbEeF").expect("valid mixed case hex digits"),
    Vec::from_hex("deadbeef").expect("valid hex digits"),
);

Re-exports

• pub use display::DisplayHex;
• pub use parse::FromHex;
• pub use parse::HexToArrayError;
• pub use parse::HexToBytesError;

Modules

• buf_encoder
  Implements a buffered encoder.
• display
  Helpers for displaying bytes as hex strings.
• exts
  Reexports of extension traits.
• parse
  Hex encoding and decoding.

Macros

• fmt_hex_exact
  Format known-length array as hex.
• test_hex_unwrap
  Quick and dirty macro for parsing hex in tests.
• write_err
  Formats error.

Structs

• BytesToHexIter
  Iterator over bytes which encodes the bytes and yields hex characters.
• HexToBytesIter
  Iterator over a hex-encoded string slice which decodes hex and yields bytes.

Enums

• Case
  Possible case of hex.