Struct HexCodec 

pub struct HexCodec { /* private fields */ }

Encodes and decodes hexadecimal byte strings.

Its low-level Codec<Value = u8, Unit = u8> implementation handles exactly one byte as two ASCII hexadecimal units. Whole-string prefix, per-byte prefix, separator, and whitespace handling remain part of the owned encode and decode helpers.

Implementations

impl HexCodec

pub fn new() -> Self

Creates a lowercase codec without prefix or separators.

Returns

A hexadecimal codec using lowercase digits.

pub fn upper() -> Self

Creates an uppercase codec without prefix or separators.

Returns

A hexadecimal codec using uppercase digits.

pub fn with_uppercase(self, uppercase: bool) -> Self

Sets whether encoded digits should be uppercase.

Parameters

• uppercase: Whether to use uppercase hexadecimal digits.

Returns

The updated codec.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Sets a whole-output prefix.

The prefix is written once before the encoded bytes and required once before decoded input. For example, using prefix 0x encodes bytes as 0x1f8b.

Parameters

• prefix: Whole-output prefix text such as 0x.

Returns

The updated codec.

pub fn with_byte_prefix(self, prefix: impl Into<String>) -> Self

Sets a per-byte prefix.

The prefix is written before every encoded byte and required before every decoded byte. For example, using byte prefix 0x and separator encodes bytes as 0x1f 0x8b.

Parameters

• prefix: Per-byte prefix text such as 0x.

Returns

The updated codec.

pub fn with_separator(self, separator: impl Into<String>) -> Self

Sets a separator written and accepted between encoded bytes.

Parameters

• separator: Separator text.

Returns

The updated codec.

pub fn with_ignored_ascii_whitespace(self, ignore: bool) -> Self

Sets whether ASCII whitespace is ignored while decoding.

Parameters

• ignore: Whether to ignore ASCII whitespace.

Returns

The updated codec.

pub fn with_ignore_prefix_case(self, ignore: bool) -> Self

Sets whether ASCII case is ignored when decoding configured prefixes.

This option affects whole-output prefixes and per-byte prefixes during decoding only. Encoding writes prefixes exactly as configured.

Parameters

• ignore: Whether to ignore ASCII case while matching prefixes.

Returns

The updated codec.

pub fn encode(&self, bytes: &[u8]) -> String

Encodes bytes into a hexadecimal string.

Parameters

• bytes: Bytes to encode.

Returns

Hexadecimal text.

pub fn encode_into(&self, bytes: &[u8], output: &mut String)

Encodes bytes into an existing string.

Parameters

• bytes: Bytes to encode.
• output: Destination string.

pub fn decode(&self, text: &str) -> MiscCodecResult<Vec<u8>>

Decodes hexadecimal text into bytes.

Parameters

• text: Hexadecimal text.

Returns

Decoded bytes.

Errors

Returns MiscCodecError when a configured whole or per-byte prefix is missing, when the normalized digit count is odd, or when a non-hex digit is found.

pub fn decode_into( &self, text: &str, output: &mut Vec<u8>, ) -> MiscCodecResult<()>

Decodes hexadecimal text into an existing byte vector.

Parameters

• text: Hexadecimal text.
• output: Destination byte vector.

Errors

Returns MiscCodecError when the input is malformed.

Trait Implementations

impl Clone for HexCodec

fn clone(&self) -> HexCodec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Codec for HexCodec

fn min_units_per_value(&self) -> NonZeroUsize

Returns the two hexadecimal digits needed for one byte.

fn max_units_per_value(&self) -> NonZeroUsize

Returns the two hexadecimal digits needed for one byte.

unsafe fn decode_unchecked( &self, input: &[u8], index: usize, ) -> Result<(u8, NonZeroUsize), Self::DecodeError>

Decodes one byte from two ASCII hexadecimal digits.

unsafe fn encode_unchecked( &self, value: &u8, output: &mut [u8], index: usize, ) -> Result<usize, Self::EncodeError>

Encodes one byte as two ASCII hexadecimal digits.

type Value = u8

Logical value decoded from or encoded into the buffer.

type Unit = u8

Buffer unit used by the encoded representation.

type DecodeError = MiscCodecError

Error reported when decoding malformed units.

type EncodeError = MiscCodecError

Error reported when encoding an unsupported value.

impl Debug for HexCodec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HexCodec

fn default() -> Self

Creates a lowercase codec without prefix or separators.

impl Eq for HexCodec

impl PartialEq for HexCodec

fn eq(&self, other: &HexCodec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HexCodec

impl ValueDecoder<str> for HexCodec

fn decode(&self, input: &str) -> Result<Self::Output, Self::Error>

Decodes hexadecimal text into bytes.

type Error = MiscCodecError

Decoding error type.

type Output = Vec<u8>

Decoded output type.

impl ValueEncoder<[u8]> for HexCodec

fn encode(&self, input: &[u8]) -> Result<Self::Output, Self::Error>

Encodes bytes into hexadecimal text.

type Error = MiscCodecError

Encoding error type.

type Output = String

Encoded output type.