Struct const_hex::Buffer

pub struct Buffer<const N: usize> { /* private fields */ }

A correctly sized stack allocation for the formatted bytes to be written into.

Examples

let mut buffer = const_hex::Buffer::new();
let printed = buffer.format(b"1234");
assert_eq!(printed, "31323334");

Implementations

impl<const N: usize> Buffer<N>

pub const fn new() -> Self

This is a cheap operation; you don’t need to worry about reusing buffers for efficiency.

pub fn clear(&mut self)

Clears the buffer.

pub const fn cleared(self) -> Self

Consumes and clears the buffer.

pub const fn const_format(self, array: &[u8; N]) -> Self

Print an array of bytes into this buffer.

pub const fn const_format_upper(self, array: &[u8; N]) -> Self

Print an array of bytes into this buffer.

pub fn format(&mut self, array: &[u8; N]) -> &mut str

Print an array of bytes into this buffer and return a reference to its lower hex string representation within the buffer.

pub fn format_upper(&mut self, array: &[u8; N]) -> &mut str

Print an array of bytes into this buffer and return a reference to its upper hex string representation within the buffer.

pub fn format_slice<T: AsRef<[u8]>>(&mut self, slice: T) -> &mut str

Print a slice of bytes into this buffer and return a reference to its lower hex string representation within the buffer.

Panics

If the slice is not exactly N bytes long.

pub fn format_slice_upper<T: AsRef<[u8]>>(&mut self, slice: T) -> &mut str

Print a slice of bytes into this buffer and return a reference to its upper hex string representation within the buffer.

Panics

If the slice is not exactly N bytes long.

pub const fn as_str(&self) -> &str

Returns a reference to the underlying bytes casted to a string slice.

Note that this contains only null (‘\0’) bytes before any formatting is done.

pub fn as_mut_str(&mut self) -> &mut str

Returns a reference to the underlying bytes casted to a string slice.

Note that this contains only null (‘\0’) bytes before any formatting is done.

pub const fn as_bytes(&self) -> &[u8]

Returns a reference to the underlying byte slice.

Note that this contains only null (‘\0’) bytes before any formatting is done.

Trait Implementations

impl<const N: usize> Clone for Buffer<N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Default for Buffer<N>

fn default() -> Self

Returns the “default value” for a type.