decode

Decodes a hexadecimal string (either case) into bytes.

The string must be made of digit pairs only: surrounding whitespace, a 0x prefix or separators are errors, so trim or strip them first.

Import

use helpers4::hex::decode;

Cargo feature hex (enabled by default). To compile only this module:

cargo add helpers4 --no-default-features --features hex

or in Cargo.toml:

[dependencies]
helpers4 = { version = "0.0.5", default-features = false, features = ["hex"] }

Signature

pub fn decode(hex: &str) -> Result<Vec<u8>, DecodeError>

Parameters

Parameter	Type	Description
hex	&str	The hexadecimal string to decode.

Returns

Result<Vec<u8>, DecodeError> — Ok on success, otherwise an Err: see Errors.

Errors

DecodeError::OddLength for an odd number of characters, DecodeError::InvalidChar for a character that is not a hex digit.

Examples

use helpers4::hex::decode;

assert_eq!(decode("DeadBeef")?, vec![0xde, 0xad, 0xbe, 0xef]);
assert!(decode("abc").is_err());

Error type: DecodeError

Why a string could not be decoded as hexadecimal.

use helpers4::hex::DecodeError;

#[non_exhaustive]
pub enum DecodeError {
    /// The string has an odd number of characters.
    OddLength,
    /// The string does not match the requested output size.
    InvalidLength {
        /// Expected number of hex characters (twice the output size).
        expected: usize,
        /// Actual number of hex characters.
        actual: usize,
    },
    /// A character that is not a hexadecimal digit.
    InvalidChar {
        /// Byte offset of the character in the input.
        index: usize,
        /// The offending character.
        found: char,
    },
}

Source

src/hex/decode.rs