Struct String 

pub struct String<const N: usize>(/* private fields */);

A UTF-8–encoded, growable string.

When heapless feature is enabled, this is wrapper around heapless::String. Otherwise, this is a wrapper around alloc::string::String, with logical length capped at N bytes.

Implementations

impl<const N: usize> String<N>

pub fn new() -> Self

Constructs a new, empty String with a capacity of N bytes.

pub fn from_utf8(vec: Vec<u8, N>) -> Result<Self>

Convert UTF-8 bytes into a String.

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire string.

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

Returns a byte slice of this String’s contents.

pub fn len(&self) -> usize

Returns the length of this String, in bytes.

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero.

pub fn push_str(&mut self, s: &str) -> Result<()>

Appends a given string slice onto the end of this String.

Returns Ok(()) if successful, or Err if capacity would be exceeded.

Trait Implementations

impl<const N: usize> AsRef<str> for String<N>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

impl<const N: usize> From<String> for String<N>

fn from(inner: String) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for String<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<const N1: usize, const N2: usize> PartialEq<String<N2>> for String<N1>

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<str> for String<N>

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

Equality operator ==.

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

Inequality operator !=.

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, const N: usize> TryFrom<&'a str> for String<N>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self>

Performs the conversion.

impl<const N: usize> Write for String<N>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.