Struct Hex 

pub struct Hex<'a> { /* private fields */ }

A borrowed view that encodes bytes as hex digits with optional framing.

Construct a view with crate::fmt::hex. Creating, copying, or configuring it does not allocate or encode the input. Each byte is always represented by two digits, in input order, including leading zero bytes.

Display and the output methods use the configured case and prefix and separator. LowerHex and UpperHex override case and prefix: :x and :X omit the prefix, while :#x and :#X include 0x. These traits retain the configured separator. Other formatting flags are ignored.

use rama_utils::fmt::hex;

let bytes = [0x00, 0xab, 0xff];
let view = hex(&bytes);
assert_eq!(view.to_string(), "00abff");
assert_eq!(view.to_vec(), b"00abff");
assert_eq!(format!("{view:#X}"), "0x00ABFF");
assert_eq!(view.with_custom_prefix("bytes:").with_separator(":").to_string(), "bytes:00:ab:ff");
assert_eq!(view.with_upper_case().with_prefix(true).to_string(), "0x00ABFF");

let mut storage = [0; 8];
assert_eq!(view.encode_to_slice(&mut storage)?, b"00abff");

Implementations

impl<'a> Hex<'a>

pub const fn with_lower_case(self) -> Hex<'a>

Available on crate features grpc and http and std only.

Select lowercase hex digits. Applies to Display and output methods.

pub fn set_lower_case(&mut self) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Select lowercase hex digits. Applies to Display and output methods.

pub const fn with_upper_case(self) -> Hex<'a>

Available on crate features grpc and http and std only.

Select uppercase hex digits. Applies to Display and output methods.

pub fn set_upper_case(&mut self) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Select uppercase hex digits. Applies to Display and output methods.

pub const fn with_prefix(self, prefix: bool) -> Hex<'a>

Available on crate features grpc and http and std only.

Enable or disable the 0x prefix for Display and output methods. The prefix itself is lowercase regardless of the digit case.

pub fn set_prefix(&mut self, prefix: bool) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Enable or disable the 0x prefix for Display and output methods. The prefix itself is lowercase regardless of the digit case.

pub const fn with_custom_prefix(self, prefix: &'a str) -> Hex<'a>

Available on crate features grpc and http and std only.

Set a custom literal prefix without allocating.

pub fn set_custom_prefix(&mut self, prefix: &'a str) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Set a custom literal prefix without allocating.

pub const fn with_separator(self, separator: &'a str) -> Hex<'a>

Available on crate features grpc and http and std only.

Set a literal separator between bytes without allocating. See Format::with_separator for details.

pub fn set_separator(&mut self, separator: &'a str) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Set a literal separator between bytes without allocating. See Format::with_separator for details.

pub const fn with_format(self, format: Format<'a>) -> Hex<'a>

Available on crate features grpc and http and std only.

Apply shared encoding/decoding configuration without allocating.

pub fn set_format(&mut self, format: Format<'a>) -> &mut Hex<'a>

Available on crate features grpc and http and std only.

Apply shared encoding/decoding configuration without allocating.

pub const fn encoded_len(&self) -> usize

Available on crate features grpc and http and std only.

Number of UTF-8 bytes in the output, including prefix and separators.

Panics

Panics if the encoded length exceeds usize::MAX. Output methods that reserve or check destination space have the same restriction.

pub fn to_vec(&self) -> Vec<u8>

Available on crate features grpc and http and std only.

Encode into a new vector of UTF-8 bytes (digits, prefix, and separators).

pub fn append_to_vec(&self, output: &mut Vec<u8>)

Available on crate features grpc and http and std only.

Append encoded bytes, reserving space without clearing existing data.

pub fn append_to_string(&self, output: &mut String)

Available on crate features grpc and http and std only.

Append hex text, reserving space without clearing existing contents.

pub fn encode_to_slice<'out>( &self, output: &'out mut [u8], ) -> Result<&'out mut [u8], BufferTooSmall>

Available on crate features grpc and http and std only.

Encode into the start of output and return the written subslice.

Does not allocate. Extra destination bytes are left untouched. If the destination is too small, returns an error without changing any bytes.

pub fn write_to<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Available on crate features grpc and http and std only.

Write configured hex text without allocating an intermediate string.

The destination can allocate as it grows. Writer errors are propagated; on failure, the destination may contain a partially written result. For a std::io::Write destination, use write!(writer, "{view}") with the I/O trait in scope instead.

Trait Implementations

impl<'a> Clone for Hex<'a>

fn clone(&self) -> Hex<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Hex<'a>

impl<'a> Debug for Hex<'a>

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

Formats the value using the given formatter.

impl Display for Hex<'_>

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

Formats the value using the given formatter.

impl LowerHex for Hex<'_>

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

Formats the value using the given formatter.

impl Serialize for Hex<'_>

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for Hex<'_>

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

Formats the value using the given formatter.