Struct FixedCapacityStringU16

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

Container for storing a UTF-8 string limited by the specified fixed bytes capacity as u16.

This is a string only by convention, there is no runtime verification done, contents is treated as regular bytes.

See also FixedCapacityStringU8 if you need to store fewer bytes.

This is just a wrapper for FixedCapacityBytesU16 that the type dereferences to with a different semantic meaning.

Implementations

impl<const CAPACITY: usize> FixedCapacityStringU16<CAPACITY>

pub fn try_from_str(s: &str) -> Option<Self>

Try to create an instance from provided string.

Returns None if provided string does not fit into the 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.

Methods from Deref<Target = FixedCapacityBytesU16<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 fn len(&self) -> u16

Number of stored bytes

pub 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 FixedCapacityStringU16<CAPACITY>

fn clone(&self) -> FixedCapacityStringU16<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 FixedCapacityStringU16<CAPACITY>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<const CAPACITY: usize> Deref for FixedCapacityStringU16<CAPACITY>

type Target = FixedCapacityBytesU16<CAPACITY>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const CAPACITY: usize> DerefMut for FixedCapacityStringU16<CAPACITY>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const CAPACITY: usize> TrivialType for FixedCapacityStringU16<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 FixedCapacityStringU16<CAPACITY>