Struct avr_progmem::string::LoadedString

#[non_exhaustive]
pub struct LoadedString<const N: usize> { /* private fields */ }

A string stored as byte array.

This type is a simple wrapper around a byte array [u8;N] and therefore, is stored as such. However, this type primarily is created from &str and derefs to &str, thus it can be used similar to String except that it is not mutable.

This type is particularly useful to store string literals in progmem.

Safety

The wrapped byte array must contain valid UTF-8.

Implementations

impl<const N: usize> LoadedString<N>

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

Creates a new byte array from the given string

Error

If the byte size of str is not exactly N, None is returned.

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

Wraps the given byte slice

Safety

The give byte slice must contain valid UTF-8.

Error

If the size of the given byte slice is not exactly N, None is returned.

pub const unsafe fn from_array(array: [u8; N]) -> Self

Wraps the given byte array

Safety

The give byte array must contain valid UTF-8.

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

Returns the underlying byte array.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<const N: usize> Deref for LoadedString<N>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<const N: usize> Hash for LoadedString<N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<const N: usize> Ord for LoadedString<N>

fn cmp(&self, other: &LoadedString<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LoadedString<N>) -> bool

This method tests for !=.

impl<const N: usize> PartialOrd<LoadedString<N>> for LoadedString<N>

fn partial_cmp(&self, other: &LoadedString<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> TryFrom<&'_ str> for LoadedString<N>

type Error = InvalidLengthError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> uDisplay for LoadedString<N>

This is supported on crate feature ufmt only.

fn fmt<W: ?Sized>(&self, fmt: &mut Formatter<'_, W>) -> Result<(), W::Error> where
    W: uWrite, 

Formats the value using the given formatter

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

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

impl<const N: usize> StructuralEq for LoadedString<N>

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