Struct FixedCapacityBytesU16

#[repr(C)]
pub struct FixedCapacityBytesU16<const CAPACITY: usize> { /* private fields */ }

Container for storing a number of bytes limited by the specified fixed capacity as u16.

See also FixedCapacityBytesU8 if you need to store fewer bytes.

In contrast to VariableBytes, which can store arbitrary amount of data and can change the capacity, this container has fixed predefined capacity and occupies it regardless of how many bytes are actually stored inside. This might seem limiting but allows implementing TrivialType trait, enabling its use for fields in data structures that derive TrivialType themselves, which isn’t the case with VariableBytes.

Implementations

impl<const CAPACITY: usize> FixedCapacityBytesU16<CAPACITY>

pub fn try_from_bytes(bytes: &[u8]) -> Option<Self>

Try to create an instance from provided bytes.

Returns None if provided bytes do not fit into the capacity.

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

Access to stored bytes

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

Exclusive access to stored bytes

pub const fn len(&self) -> u16

Number of stored bytes

pub const fn is_empty(&self) -> bool

Returns true if length is zero

pub fn append(&mut self, bytes: &[u8]) -> bool

Append some bytes.

true is returned on success, but if there isn’t enough capacity left, false is.

pub fn truncate(&mut self, new_len: u16) -> bool

Truncate stored bytes to this length.

Returns true on success or false if new_len is larger than Self::len().

pub fn copy_from<T>(&mut self, src: &[u8]) -> bool

Copy from specified bytes.

Returns false if capacity is not enough to copy contents of src

Trait Implementations

impl<const CAPACITY: usize> Clone for FixedCapacityBytesU16<CAPACITY>

fn clone(&self) -> FixedCapacityBytesU16<CAPACITY>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const CAPACITY: usize> Debug for FixedCapacityBytesU16<CAPACITY>

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

Formats the value using the given formatter.

impl<const CAPACITY: usize> Default for FixedCapacityBytesU16<CAPACITY>

fn default() -> Self

Returns the “default value” for a type.

impl<const CAPACITY: usize> TrivialType for FixedCapacityBytesU16<CAPACITY>

const METADATA: &[u8]

Data structure metadata in binary form, describing shape and types of the contents, see IoTypeMetadataKind for encoding details.

const SIZE: u32 = _

unsafe fn from_bytes(bytes: &[u8]) -> Option<&Self>

Create a reference to a type, which is represented by provided memory.

unsafe fn from_bytes_mut(bytes: &mut [u8]) -> Option<&mut Self>

Create a mutable reference to a type, which is represented by provided memory.

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

Access the underlying byte representation of a data structure

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

Access the underlying mutable byte representation of a data structure.

impl<const CAPACITY: usize> Copy for FixedCapacityBytesU16<CAPACITY>