Struct stackstring::string::String

pub struct String<const L: usize>(_);

Implementations

impl<const L: usize> String<L>

A non-zero sized inlined String. It doesn’t keep any length, the assumption is that the capacity is always utilised.

pub const fn empty() -> Self

pub fn try_from_str_padded(s: impl AsRef<str>) -> Result<Self, Error<L>>

Constructs a String<L> from an at most L bytes-long string slice, left-padding if the slice is less than L bytes-long.

Example

let s = "three";
let string = String::<9>::try_from_str_padded(s).unwrap();

assert_eq!(string, "three    ");

let string_err = String::<3>::try_from_str_padded(s);

assert!(string_err.is_err());

pub fn try_from_bytes_padded(bytes: impl AsRef<[u8]>) -> Result<Self, Error<L>>

Constructs a String<L> from at most L bytes. left-padding if the number of bytes is less than L.

Example

let bytes = b"three";
let string = String::<9>::try_from_bytes_padded(bytes).unwrap();

assert_eq!(string.as_bytes(), b"three    ");

pub const fn builder() -> StringBuilder<L>

pub fn as_str(&self) -> &str

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

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

pub fn into_bytes(self) -> [u8; L]

Turns the String into its underlying bytes.

pub fn is_empty(&self) -> bool

Returns whether all bytes in the String are empty.

pub fn starts_empty(&self) -> bool

Returns whether the first byte of the String is empty. Can be used as a faster version of is_empty.

Trait Implementations

impl<const L: usize> Clone for String<L>

fn clone(&self) -> String<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const L: usize> Debug for String<L>

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

Formats the value using the given formatter.

impl<const L: usize> Default for String<L>

fn default() -> Self

Returns the “default value” for a type.

impl<const L: usize> Deref for String<L>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<const L: usize> DerefMut for String<L>

fn deref_mut(&mut self) -> &mut str

Mutably dereferences the value.

impl<const L: usize> From<[u8; L]> for String<L>

fn from(buf: [u8; L]) -> Self

Performs the conversion.

impl<const L: usize> Hash for String<L>

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 L: usize> Index<Range<usize>> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> Index<RangeFrom<usize>> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> Index<RangeFull> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> Index<RangeInclusive<usize>> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> Index<RangeTo<usize>> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> Index<RangeToInclusive<usize>> for String<L>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<const L: usize> IndexMut<Range<usize>> for String<L>

fn index_mut(&mut self, index: Range<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> IndexMut<RangeFrom<usize>> for String<L>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> IndexMut<RangeFull> for String<L>

fn index_mut(&mut self, _index: RangeFull) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> IndexMut<RangeInclusive<usize>> for String<L>

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> IndexMut<RangeTo<usize>> for String<L>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> IndexMut<RangeToInclusive<usize>> for String<L>

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<const L: usize> Ord for String<L>

fn cmp(&self, other: &String<L>) -> 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 L: usize> PartialEq<&'_ str> for String<L>

fn eq(&self, other: &&str) -> bool

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

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

This method tests for !=.

impl<const L: usize> PartialEq<String<L>> for String<L>

fn eq(&self, other: &String<L>) -> bool

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

fn ne(&self, other: &String<L>) -> bool

This method tests for !=.

impl<const L: usize> PartialEq<String<L>> for &str

fn eq(&self, other: &String<L>) -> bool

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

fn ne(&self, other: &String<L>) -> bool

This method tests for !=.

impl<const L: usize> PartialEq<String<L>> for String

fn eq(&self, other: &String<L>) -> bool

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

fn ne(&self, other: &String<L>) -> bool

This method tests for !=.

impl<const L: usize> PartialEq<String> for String<L>

fn eq(&self, other: &String) -> bool

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

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

This method tests for !=.

impl<const L: usize> PartialOrd<String<L>> for String<L>

fn partial_cmp(&self, other: &String<L>) -> 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 L: usize> TryFrom<&'_ str> for String<L>

type Error = Error<L>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const L: usize> Copy for String<L>

impl<const L: usize> Eq for String<L>

impl<const L: usize> StructuralEq for String<L>