Struct FixedCapacityString 

pub struct FixedCapacityString<const CAPACITY: usize> { /* private fields */ }

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

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

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

CAPACITY must not exceed u32::MAX - 4.

Implementations

impl<const CAPACITY: usize> FixedCapacityString<CAPACITY>

where [(); _]:,

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_slice(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 = FixedCapacityElements<u8, CAPACITY>>

pub fn get_elements(&self) -> &[Element]

Access to stored elements.

Returns no elements if the number of elements exceeds CAPACITY, which is only possible for an instance created from invalid bytes.

pub fn get_elements_mut(&mut self) -> &mut [Element]

Exclusive access to stored elements.

Returns no elements if the number of elements exceeds CAPACITY, which is only possible for an instance created from invalid bytes.

pub fn len(&self) -> u32

Number of stored elements.

May exceed CAPACITY for an instance created from invalid bytes.

pub fn is_empty(&self) -> bool

Returns true if there are no stored elements

pub fn append(&mut self, elements: &[Element]) -> bool

Append some elements.

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

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

Truncate stored elements to this length.

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

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

Copy from specified elements, replacing stored elements.

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

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

where [(); _]:,

fn default() -> Self

Returns the “default value” for a type.

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

type Target = FixedCapacityElements<u8, CAPACITY>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

where [(); _]:,

const ALIGNMENT: Alignment = FixedCapacityElements<u8, CAPACITY>::ALIGNMENT

Alignment of the type in metadata.

const METADATA: &[u8]

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

fn try_from_bytes_unaligned(bytes: &[u8]) -> Option<(&Unaligned<Self>, &[u8])>

Parse the beginning of bytes, which don’t need to be aligned.

const SIZE: u32 = _

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

Parse the beginning of aligned bytes, returns the value and the remaining bytes.

final fn try_from_bytes_exact(bytes: &[u8]) -> Option<&Self>

Like Self::try_from_bytes(), but returns None if there are more bytes than the value

final fn try_from_bytes_mut(bytes: &mut [u8]) -> Option<(&mut Self, &mut [u8])>

Like Self::try_from_bytes(), but returns an exclusive reference.

final fn try_read_unaligned(bytes: &[u8]) -> Option<(Self, &[u8])>

Read a copy from the beginning of bytes, which don’t need to be aligned, returns the value and the remaining bytes

final fn try_read_unaligned_exact(bytes: &[u8]) -> Option<Self>

Like Self::try_read_unaligned(), but returns None if there are more bytes than the value

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

Read unaligned value from memory.

final unsafe fn read_unaligned_unchecked(bytes: &[u8]) -> Self

Similar to Self::read_unaligned(), but doesn’t do any checks at all.

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

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

final unsafe fn from_bytes_unchecked(bytes: &[u8]) -> &Self

Similar to Self::from_bytes(), but doesn’t do any checks at all.

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

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

final unsafe fn from_bytes_mut_unchecked(bytes: &mut [u8]) -> &mut Self

Similar to Self::from_bytes_mut(), but doesn’t do any checks at all.

final fn as_bytes(&self) -> &[u8; _]

Access the underlying byte representation of a data structure

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

Access the underlying mutable byte representation of a data structure.