Struct Format 

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

Shared hex representation for encoding and decoding.

Defaults to lowercase without a prefix or separator. Decoding accepts either digit case and requires the configured prefix and separators exactly. Configuration only borrows text; it never allocates. Both strings share a lifetime, shortened as needed when combining independently borrowed values.

use rama_utils::{fmt::hex, hex::Format};
const FORMAT: Format<'static> = Format::new()
    .with_upper_case().with_prefix("hash:").with_separator(":");
let view = hex(&[0, 0xab, 255]).with_format(FORMAT);
assert_eq!(view.to_string(), "hash:00:AB:FF");
assert_eq!(FORMAT.decode::<[u8; 3]>("hash:00:aB:ff")?, [0, 0xab, 255]);

Implementations

impl Format<'_>

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

where S: Serializer, B: AsRef<[u8]> + ?Sized,

Available on crate features grpc and http and std only.

Serialize byte-like input with this format, without an intermediate hex string unless the serializer itself needs one.

pub fn deserialize<'de, D, T>( &self, deserializer: D, ) -> Result<T, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>, T: FromHex,

Available on crate features grpc and http and std only.

Deserialize into a FromHex destination using this format.

impl Format<'_>

pub fn decode<T>(&self, input: impl AsRef<[u8]>) -> Result<T, DecodeError>

where T: FromHex,

Available on crate features grpc and http and std only.

Decode using this format, accepting either digit case and requiring the configured prefix and separators. All input must be consumed.

pub fn decode_into<'out, B>( &self, input: impl AsRef<[u8]>, output: &'out mut B, ) -> Result<&'out mut [u8], DecodeError>

where B: AsMut<[u8]> + ?Sized,

Available on crate features grpc and http and std only.

Decode with this format into the start of an existing buffer. See decode_into for destination and error behavior.

pub fn decode_append<B>( &self, input: impl AsRef<[u8]>, output: &mut B, ) -> Result<usize, DecodeError>

where B: Extend<u8> + ?Sized,

Available on crate features grpc and http and std only.

Append bytes decoded with this format to a growing collection. See decode_append for destination and error behavior.

pub fn decode_write<W>( &self, input: impl AsRef<[u8]>, output: &mut W, ) -> Result<usize, DecodeWriteError>

where W: Write + ?Sized,

Available on crate features grpc and http and std only.

Write bytes decoded with this format to an I/O destination. See decode_write for validation and partial-write behavior.

impl<'a> Format<'a>

pub const fn new() -> Format<'a>

Available on crate features grpc and http and std only.

Lowercase, unprefixed hex.

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

Available on crate features grpc and http and std only.

Select lowercase hex digits. Decoding always accepts both cases.

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

Available on crate features grpc and http and std only.

Select lowercase hex digits. Decoding always accepts both cases.

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

Available on crate features grpc and http and std only.

Select uppercase hex digits. Decoding always accepts both cases.

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

Available on crate features grpc and http and std only.

Select uppercase hex digits. Decoding always accepts both cases.

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

Available on crate features grpc and http and std only.

Select a literal prefix, required exactly once when decoding. An empty string disables the prefix.

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

Available on crate features grpc and http and std only.

Select a literal prefix, required exactly once when decoding. An empty string disables the prefix.

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

Available on crate features grpc and http and std only.

Insert this literal separator between bytes, never at either end.

Decoding requires it at every byte boundary. An empty separator selects compact hex. Any UTF-8 text, including hex digits, is supported; decoding uses fixed two-digit byte groups rather than splitting on the separator.

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

Available on crate features grpc and http and std only.

Insert this literal separator between bytes, never at either end.

Decoding requires it at every byte boundary. An empty separator selects compact hex. Any UTF-8 text, including hex digits, is supported; decoding uses fixed two-digit byte groups rather than splitting on the separator.

Trait Implementations

impl<'a> Clone for Format<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Format<'a>

impl<'a> Debug for Format<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Format<'a>

fn default() -> Format<'a>

Returns the “default value” for a type.

impl<'a> Eq for Format<'a>

impl<'a> PartialEq for Format<'a>

fn eq(&self, other: &Format<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Format<'a>