Struct FixedBytes 

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

Stack-allocated arbitrary bytes with a fixed maximum capacity.

Implementations

impl<const N: usize> FixedBytes<N>

pub const fn new() -> Self

Creates an empty buffer.

pub const fn empty() -> Self

Compatibility name for new.

pub const fn with_size(size: usize) -> Self

Creates a zero-filled buffer with an initialized length.

Panics

Panics when size exceeds the capacity.

pub const fn len(&self) -> usize

Returns the number of initialized bytes.

pub const fn is_empty(&self) -> bool

Returns whether the buffer contains no initialized bytes.

pub const fn capacity(&self) -> usize

Returns the maximum number of bytes the buffer can hold.

pub const fn remaining_capacity(&self) -> usize

Returns the number of bytes that can still be appended.

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

Returns the initialized portion of the buffer.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Returns the initialized portion of the buffer mutably.

pub fn try_as_str(&self) -> Result<&str, Utf8Error>

Interprets the initialized bytes as UTF-8.

pub fn as_str(&self) -> &str

Returns the initialized bytes as UTF-8.

Panics

Panics if the buffer does not contain valid UTF-8.

pub fn clear(&mut self)

Removes all initialized bytes.

pub fn truncate(&mut self, new_len: usize)

Shortens the initialized portion to new_len.

Panics

Panics if new_len exceeds the current length.

pub fn allocate(&mut self, bytes: usize)

Extends the initialized portion with zero-filled bytes.

Panics

Panics if the requested bytes exceed the remaining capacity.

pub fn try_from_slice(value: &[u8]) -> Result<Self, CapacityError>

Copies a byte slice into a new buffer.

pub fn try_push_slice( &mut self, value: &[u8], ) -> Result<Range<usize>, CapacityError>

Appends a slice and returns the occupied range.

pub fn push_slice(&mut self, value: &[u8]) -> Range<usize>

Appends a slice and returns the occupied range.

Panics

Panics if the slice exceeds the remaining capacity.

pub fn try_push_byte(&mut self, value: u8) -> Result<usize, CapacityError>

Appends one byte and returns its index.

pub fn push_byte(&mut self, value: u8) -> usize

Appends one byte and returns its index.

Panics

Panics if the buffer is full.

Trait Implementations

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

fn clone(&self) -> FixedBytes<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Copy for FixedBytes<N>

impl<const N: usize> Debug for FixedBytes<N>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Display for FixedBytes<N>

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

Formats the value using the given formatter.

impl<const N: usize> Eq for FixedBytes<N>

impl<const N: usize> From<&[u8; N]> for FixedBytes<N>

fn from(value: &[u8; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&[u8]> for FixedBytes<N>

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl<const N: usize> PartialEq for FixedBytes<N>

fn eq(&self, other: &FixedBytes<N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> StructuralPartialEq for FixedBytes<N>

impl<const N: usize> TryFrom<FixedBytes<N>> for FixedStr<N>

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: FixedBytes<N>) -> Result<Self, Self::Error>

Performs the conversion.