Struct HexCodec 

pub struct HexCodec { /* private fields */ }

Encodes and decodes hexadecimal byte strings.

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 per-byte prefix.

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

This is not a whole-output prefix: [0x1F, 0x8B] is encoded as 0x1F 0x8B, not 0x1F 8B.

Parameters

• prefix: 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 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) -> CodecResult<Vec<u8>>

Decodes hexadecimal text into bytes.

Parameters

• text: Hexadecimal text.

Returns

Decoded bytes.

Errors

Returns CodecError when a configured 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>) -> CodecResult<()>

Decodes hexadecimal text into an existing byte vector.

Parameters

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

Errors

Returns CodecError 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 Debug for HexCodec

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

Formats the value using the given formatter.

impl Decoder<str> for HexCodec

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

Decodes hexadecimal text into bytes.

type Error = CodecError

Decoding error type.

type Output = Vec<u8>

Decoded output type.

impl Default for HexCodec

fn default() -> Self

Creates a lowercase codec without prefix or separators.

impl Encoder<[u8]> for HexCodec

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

Encodes bytes into hexadecimal text.

type Error = CodecError

Encoding error type.

type Output = String

Encoded output type.

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 Eq for HexCodec

impl StructuralPartialEq for HexCodec