Struct staticvec::StaticString

pub struct StaticString<const N: usize> { /* fields omitted */ }

A fixed-capacity String-like struct built around an instance of StaticVec<u8, N>.

Examples

use staticvec::{StaticString, StringError};

#[derive(Debug)]
pub struct User {
  pub username: StaticString<20>,
  pub role: StaticString<5>,
}

fn main() -> Result<(), StringError> {
  let user = User {
    username: StaticString::try_from_str("user")?,
    role: StaticString::try_from_str("admin")?,
  };
  println!("{:?}", user);
  Ok(())
}

Methods

impl<const N: usize> StaticString<N>

pub const fn new() -> Self

Returns a new StaticString instance.

Example usage:

let string = StaticString::<20>::new();
assert!(string.is_empty());

pub unsafe fn from_str_unchecked(string: &str) -> Self

Creates a new StaticString instance from string, without doing any checking to ensure that the length of string does not exceed the resulting StaticString's declared capacity.

Safety

The length of string must not exceed the declared capacity of the StaticString being created, as this would result in writing to an out-of-bounds memory region.

Example usage:

let string = unsafe { StaticString::<20>::from_str_unchecked("My String") };
assert_eq!(string, "My String");

pub fn from_str<S: AsRef<str>>(string: S) -> Self

Creates a new StaticString from string, truncating string as necessary if it has a length greater than the StaticString's declared capacity.

Example usage:

let string = StaticString::<20>::from_str("My String");
assert_eq!(string, "My String");
let truncate = "0".repeat(21);
let truncated = "0".repeat(20);
let string = StaticString::<20>::from_str(&truncate);
assert_eq!(string, truncated.as_str());

pub fn try_from_str<S: AsRef<str>>(string: S) -> Result<Self, CapacityError<N>>

Creates a new StaticString from string if the length of string is less than or equal to the StaticString's declared capacity, or returns a CapacityError otherwise.

Example usage:

let string = StaticString::<20>::from("My String");
assert_eq!(string.as_str(), "My String");
assert_eq!(StaticString::<20>::try_from_str("").unwrap().as_str(), "");
let out_of_bounds = "0".repeat(21);
assert!(StaticString::<20>::try_from_str(out_of_bounds).is_err());

pub fn from_iterator<U: AsRef<str>, I: IntoIterator<Item = U>>(iter: I) -> Self

Creates a new StaticString from the contents of an iterator, returning immediately if and when the StaticString reaches maximum capacity regardless of whether or not the iterator still has more items to yield.

Example usage:

let string = StaticString::<300>::from_iterator(&["My String", " Other String"][..]);
assert_eq!(string.as_str(), "My String Other String");
let out_of_bounds = (0..400).map(|_| "000");
let truncated = "0".repeat(18);
let truncate = StaticString::<20>::from_iterator(out_of_bounds);
assert_eq!(truncate.as_str(), truncated.as_str());

pub fn try_from_iterator<U: AsRef<str>, I: IntoIterator<Item = U>>(
    iter: I
) -> Result<Self, CapacityError<N>>

Creates a new StaticString from the contents of an iterator if the iterator has a length less than or equal to the StaticString's declared capacity, or returns a CapacityError otherwise.

Example usage:

let string = StaticString::<300>::try_from_iterator(
  &["My String", " My Other String"][..]
).unwrap();
assert_eq!(string.as_str(), "My String My Other String");
let out_of_bounds = (0..100).map(|_| "000");
assert!(StaticString::<20>::try_from_iterator(out_of_bounds).is_err());

pub fn from_chars<I: IntoIterator<Item = char>>(iter: I) -> Self

Creates a new StaticString from the contents of a char iterator, returning immediately if and when the StaticString reaches maximum capacity regardless of whether or not the iterator still has more items to yield.

let string = StaticString::<20>::from_chars("My String".chars());
assert_eq!(string, "My String");
let out_of_bounds = "0".repeat(21);
let truncated = "0".repeat(20);
let truncate = StaticString::<20>::from_chars(out_of_bounds.chars());
assert_eq!(truncate.as_str(), truncated.as_str());

pub fn try_from_chars<I: IntoIterator<Item = char>>(
    iter: I
) -> Result<Self, StringError>

Creates a new StaticString from the contents of a char iterator if the iterator has a length less than or equal to the StaticString's declared capacity, or returns StringError::OutOfBounds otherwise.

Example usage:

let string = StaticString::<20>::try_from_chars("My String".chars())?;
assert_eq!(string.as_str(), "My String");
let out_of_bounds = "0".repeat(21);
assert!(StaticString::<20>::try_from_chars(out_of_bounds.chars()).is_err());

pub unsafe fn from_utf8_unchecked<B: AsRef<[u8]>>(slice: B) -> Self

Creates a new StaticString instance from the provided byte slice, without doing any checking to ensure that the slice contains valid UTF-8 data and has a length less than or equal to the declared capacity of the StaticString.

Safety

The length of the slice must not exceed the declared capacity of the StaticString being created, as this would result in writing to an out-of-bounds memory region.

The slice must also contain strictly valid UTF-8 data, as if it does not, various assumptions made in the internal implementation of StaticString will be silently invalidated, almost certainly eventually resulting in undefined behavior.

Example usage:

let string = unsafe { StaticString::<20>::from_utf8_unchecked("My String") };
assert_eq!(string, "My String");
// Undefined behavior, don't do it:
// let out_of_bounds = "0".repeat(300);
// let ub = unsafe { StaticString::<20>::from_utf8_unchecked(out_of_bounds)) };

pub fn from_utf8<B: AsRef<[u8]>>(slice: B) -> Result<Self, StringError>

Creates a new StaticString instance from the provided byte slice, returning StringError::Utf8 on invalid UTF-8 data, and truncating the input slice as necessary if it has a length greater than the declared capacity of the StaticString being created.

Example usage:

let string = StaticString::<20>::from_utf8("My String")?;
assert_eq!(string, "My String");
let invalid_utf8 = [0, 159, 146, 150];
assert!(StaticString::<20>::from_utf8(invalid_utf8).unwrap_err().is_utf8());
let out_of_bounds = "0".repeat(300);
assert_eq!(StaticString::<20>::from_utf8(out_of_bounds.as_bytes())?.as_str(), "0".repeat(20).as_str());

pub fn try_from_utf8<B: AsRef<[u8]>>(slice: B) -> Result<Self, StringError>

Creates a new StaticString from the provided byte slice, returning StringError::Utf8 on invalid UTF-8 data or StringError::OutOfBounds if the slice has a length greater than the StaticString's declared capacity.

Example usage:

let string = StaticString::<20>::try_from_utf8("My String")?;
assert_eq!(string, "My String");
let invalid_utf8 = [0, 159, 146, 150];
assert!(StaticString::<20>::try_from_utf8(invalid_utf8).unwrap_err().is_utf8());
let out_of_bounds = "0000".repeat(400);
assert!(StaticString::<20>::try_from_utf8(out_of_bounds.as_bytes()).unwrap_err().is_out_of_bounds());

pub fn from_utf16_lossy<B: AsRef<[u16]>>(slice: B) -> Self

Creates a new StaticString instance from the provided u16 slice, replacing invalid UTF-16 data with REPLACEMENT_CHARACTER (�), and truncating the input slice as necessary if it has a length greater than the declared capacity of the StaticString being created.

Example usage:

let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
let string = StaticString::<20>::from_utf16_lossy(music);
assert_eq!(string, "𝄞music");
let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
assert_eq!(StaticString::<20>::from_utf16_lossy(invalid_utf16).as_str(), "𝄞mu\u{FFFD}ic");
let out_of_bounds: Vec<u16> = (0..300).map(|_| 0).collect();
assert_eq!(StaticString::<20>::from_utf16_lossy(&out_of_bounds).as_str(), "\0".repeat(20).as_str());

pub fn from_utf16<B: AsRef<[u16]>>(slice: B) -> Result<Self, StringError>

Creates a new StaticString instance from the provided u16 slice, returning StringError::Utf16 on invalid UTF-16 data, and truncating the input slice as necessary if it has a length greater than the declared capacity of the StaticString being created.

Example usage:

let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
let string = StaticString::<20>::from_utf16(music)?;
assert_eq!(string.as_str(), "𝄞music");
let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
assert!(StaticString::<20>::from_utf16(invalid_utf16).unwrap_err().is_utf16());
let out_of_bounds: Vec<u16> = (0..300).map(|_| 0).collect();
assert_eq!(StaticString::<20>::from_utf16(out_of_bounds)?.as_str(),
           "\0".repeat(20).as_str());

pub fn try_from_utf16<B: AsRef<[u16]>>(slice: B) -> Result<Self, StringError>

Creates a new StaticString from the provided u16 slice, returning StringError::Utf16 on invalid UTF-16 data or StringError::OutOfBounds if the slice has a length greater than the declared capacity of the StaticString being created.

Example usage:

let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
let string = StaticString::<20>::try_from_utf16(music)?;
assert_eq!(string.as_str(), "𝄞music");
let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
assert!(StaticString::<20>::try_from_utf16(invalid_utf16).unwrap_err().is_utf16());
let out_of_bounds: StaticVec<u16, 300> = (0..300).map(|_| 0).collect();
assert!(StaticString::<20>::try_from_utf16(out_of_bounds).unwrap_err().is_out_of_bounds());

pub const fn as_str(&self) -> &str

Extracts a str slice containing the entire contents of the StaticString.

Example usage:

let s = StaticString::<20>::from_str("My String");
assert_eq!(s.as_str(), "My String");

pub const fn as_mut_str(&mut self) -> &mut str

Extracts a mutable str slice containing the entire contents of the StaticString.

Example usage:

let mut s = StaticString::<20>::from_str("My String");
assert_eq!(s.as_mut_str(), "My String");

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

Extracts a u8 slice containing the entire contents of the StaticString.

Example usage:

let s = StaticString::<20>::from_str("My String");
assert_eq!(s.as_bytes(), "My String".as_bytes());

pub fn into_bytes(self) -> StaticVec<u8, N>

Returns the StaticString's internal instance of StaticVec<u8, N>. Note that using this function consumes the StaticString.

Example usage:

let s = StaticString::<5>::from("hello");
let bytes = s.into_bytes();
assert_eq!(&bytes[..], &[104, 101, 108, 108, 111][..]);

pub const unsafe fn as_mut_bytes(&mut self) -> &mut [u8]

Extracts a mutable u8 slice containing the entire contents of the StaticString.

Safety

Care must be taken to ensure that the returned u8 slice is not mutated in such a way that it no longer amounts to valid UTF-8.

Example usage:

let mut s = StaticString::<20>::try_from_str("My String")?;
assert_eq!(unsafe { s.as_mut_bytes() }, "My String".as_bytes());

pub const unsafe fn as_mut_staticvec(&mut self) -> &mut StaticVec<u8, N>

Returns a mutable reference to the StaticString's backing StaticVec.

Safety

Care must be taken to ensure that the returned StaticVec reference is not mutated in such a way that it no longer contains valid UTF-8.

Example usage:

let mut s = StaticString::<20>::try_from_str("My String")?;
assert_eq!(unsafe { s.as_mut_staticvec() }, "My String".as_bytes());

pub const fn capacity(&self) -> usize

Returns the total capacity of the StaticString. This is always equivalent to the generic N parameter it was declared with, which determines the fixed size of the backing StaticVec instance.

Example usage:

assert_eq!(StaticString::<32>::new().capacity(), 32);

pub const fn remaining_capacity(&self) -> usize

Returns the remaining capacity (which is to say, self.capacity() - self.len()) of the StaticString.

Example usage:

assert_eq!(StaticString::<32>::from("abcd").remaining_capacity(), 28);

pub unsafe fn push_str_unchecked(&mut self, string: &str)

Pushes string to the StaticString without doing any checking to ensure that self.len() + string.len() does not exceed the StaticString's total capacity.

Safety

self.len() + string.len() must not exceed the total capacity of the StaticString instance, as this would result in writing to an out-of-bounds memory region.

Example usage:

let mut s = StaticString::<6>::from("foo");
unsafe { s.push_str_unchecked("bar") };
assert_eq!(s, "foobar");

pub fn push_str<S: AsRef<str>>(&mut self, string: S)

Attempts to push string to the StaticString, panicking if it is the case that self.len() + string.len() exceeds the StaticString's total capacity.

Example usage:

let mut s = StaticString::<6>::from("foo");
s.push_str("bar");
assert_eq!(s, "foobar");

pub fn push_str_truncating<S: AsRef<str>>(&mut self, string: S)

Attempts to push string to the StaticString. Truncates string as necessary (or simply does nothing at all) if it is the case that self.len() + string.len() exceeds the StaticString's total capacity.

Example usage:

let mut s = StaticString::<300>::try_from_str("My String")?;
s.push_str_truncating(" My other String");
assert_eq!(s.as_str(), "My String My other String");
let mut s = StaticString::<20>::new();
s.push_str_truncating("0".repeat(21));
assert_eq!(s.as_str(), "0".repeat(20).as_str());

pub fn try_push_str<S: AsRef<str>>(
    &mut self,
    string: S
) -> Result<(), CapacityError<N>>

Pushes string to the StaticString if self.len() + string.len() does not exceed the StaticString's total capacity, or returns a CapacityError otherwise.

Example usage:

let mut s = StaticString::<300>::from("My String");
s.try_push_str(" My other String").unwrap();
assert_eq!(s.as_str(), "My String My other String");
assert!(s.try_push_str("0".repeat(300)).is_err());

pub unsafe fn push_unchecked(&mut self, character: char)

Appends the given char to the end of the StaticString without doing any checking to ensure that self.len() + character.len_utf8() does not exceed the total capacity of the StaticString instance.

Safety

self.len() + character.len_utf8() must not exceed the total capacity of the StaticString instance, as this would result in writing to an out-of-bounds memory region.

Example usage:

let mut s = StaticString::<20>::try_from_str("My String")?;
unsafe { s.push_unchecked('!') };
assert_eq!(s.as_str(), "My String!");
// Undefined behavior, don't do it:
// s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
// s.push_unchecked('!');

pub fn push(&mut self, character: char)

Appends the given char to the end of the StaticString, panicking if the StaticString is already at maximum capacity.

Example usage:

let mut string = StaticString::<2>::new();
string.push('a');
string.push('b');
assert_eq!(&string[..], "ab");

pub fn try_push(&mut self, character: char) -> Result<(), StringError>

Appends the given char to the end of the StaticString, returning StringError::OutOfBounds if the StaticString is already at maximum capacity.

Example usage:

let mut s = StaticString::<20>::try_from_str("My String")?;
s.try_push('!')?;
assert_eq!(s.as_str(), "My String!");
let mut s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
assert!(s.try_push('!').is_err());

pub fn truncate(&mut self, new_len: usize)

Truncates the StaticString to new_len if new_len is less than or equal to the StaticString's current length, or does nothing otherwise. Panics if new_len does not lie at a valid UTF-8 character boundary.

Example usage:

let mut s = StaticString::<20>::from("My String");
s.truncate(5);
assert_eq!(s, "My St");
// Does nothing
s.truncate(6);
assert_eq!(s, "My St");
// Would panic
// let mut s2 = StaticString::<20>::from("🤔");
// s2.truncate(1);

pub fn pop(&mut self) -> Option<char>

Returns the last character in the StaticString in Some if the StaticString's current length is greater than zero, or None otherwise.

Example usage:

let mut s = StaticString::<20>::try_from_str("A🤔")?;
assert_eq!(s.pop(), Some('🤔'));
assert_eq!(s.pop(), Some('A'));
assert_eq!(s.pop(), None);

pub fn trim(&mut self)

Removes all whitespace from the beginning and end of the StaticString, if any is present.

Example usage:

let mut string = StaticString::<300>::try_from_str("   to be trimmed     ")?;
string.trim();
assert_eq!(string.as_str(), "to be trimmed");
let mut string = StaticString::<20>::try_from_str("   🤔")?;
string.trim();
assert_eq!(string.as_str(), "🤔");

pub fn remove(&mut self, index: usize) -> char

Removes the char at index from the StaticString if index is both less than self.len() and also lies at a valid UTF-8 character boundary, or panics otherwise.

Example usage:

let mut s = StaticString::<20>::from("ABCD🤔");
assert_eq!(s.remove(0), 'A');
assert!(s == "BCD🤔");
assert_eq!(s.remove(2), 'D');
assert!(s == "BC🤔");

pub fn retain<F: FnMut(char) -> bool>(&mut self, f: F)

Removes all characters from the StaticString except for those specified by the predicate function.

Example usage:

let mut s = StaticString::<20>::from("ABCD🤔");
s.retain(|c| c != '🤔');
assert_eq!(s, "ABCD");

pub unsafe fn insert_unchecked(&mut self, index: usize, character: char)

Inserts character at index, shifting any values that exist in positions greater than index to the right.

Does not do any checking to ensure that character.len_utf8() + self.len() does not exceed the total capacity of the StaticString or that index lies at a valid UTF-8 character boundary.

Safety

The length of the StaticString prior to calling this function must be less than its total capacity, as if this in not the case it will result in writing to an out-of-bounds memory region.

Index must also lie at a valid UTF-8 character boundary, as if it does not, various assumptions made in the internal implementation of StaticString will be silently invalidated, almost certainly eventually resulting in undefined behavior.

Example usage:

let mut s = StaticString::<20>::try_from_str("ABCD🤔")?;
unsafe { s.insert_unchecked(1, 'A') };
unsafe { s.insert_unchecked(1, 'B') };
assert_eq!(s.as_str(), "ABABCD🤔");
// Undefined behavior, don't do it:
// s.insert(20, 'C');
// s.insert(8, 'D');

pub fn try_insert(
    &mut self,
    index: usize,
    character: char
) -> Result<(), StringError>

Inserts character at index, shifting any values that exist in positions greater than index to the right.

Returns StringError::OutOfBounds if character.len_utf8() + self.len() exceeds the total capacity of the StaticString and StringError::NotCharBoundary if index does not lie at a valid UTF-8 character boundary.

Example usage:

let mut s = StaticString::<20>::try_from_str("ABCD🤔")?;
s.try_insert(1, 'E')?;
s.try_insert(2, 'F')?;
assert_eq!(s.as_str(), "AEFBCD🤔");
assert!(s.try_insert(20, 'C').unwrap_err().is_not_char_boundary());
assert!(s.try_insert(8, 'D').unwrap_err().is_not_char_boundary());
let mut s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
assert!(s.try_insert(0, 'C').unwrap_err().is_out_of_bounds());

pub fn insert(&mut self, index: usize, character: char)

Inserts character at index, shifting any values that exist in positions greater than index to the right.

Panics if character.len_utf8() + self.len() exceeds the total capacity of the StaticString or if index does not lie at a valid UTF-8 character boundary.

Example usage:

let mut s = StaticString::<3>::new();
s.insert(0, 'f');
s.insert(1, 'o');
s.insert(2, 'o');
assert_eq!(s, "foo");

pub unsafe fn insert_str_unchecked<S: AsRef<str>>(
    &mut self,
    index: usize,
    string: S
)

Inserts string at index, shifting any values that exist in positions greater than index to the right.

Does not do any checking to ensure that self.len() + string.len() does not exceed the total capacity of the StaticString or that index lies at a valid UTF-8 character boundary.

Safety

self.len() + string.len() must not exceed the total capacity of the StaticString instance, as this would result in writing to an out-of-bounds memory region.

Index must also lie at a valid UTF-8 character boundary, as if it does not, various assumptions made in the internal implementation of StaticString will be silently invalidated, almost certainly eventually resulting in undefined behavior.

Example usage:

let mut s = StaticString::<20>::from_str("ABCD🤔");
unsafe { s.insert_str_unchecked(1, "AB") };
unsafe { s.insert_str_unchecked(1, "BC") };
assert_eq!(s, "ABCABBCD🤔");
// Undefined behavior, don't do it:
// unsafe { s.insert_str_unchecked(20, "C") };
// unsafe { s.insert_str_unchecked(10, "D") };
// unsafe { s.insert_str_unchecked(1, "0".repeat(20)) };

pub fn insert_str<S: AsRef<str>>(&mut self, index: usize, string: S)

Inserts string at index, shifting any values that exist in positions greater than index to the right.

Panics if index is greater than the length of the StaticString or if it does not lie at a valid UTF-8 character boundary, as well as if string.len() + self.len() exceeds the total capacity of the StaticString.

Example usage:

let mut s = StaticString::<20>::from("ABCD🤔");
s.insert_str(1, "AB");
s.insert_str(1, "BC");
assert_eq!(s.as_str(), "ABCABBCD🤔");

pub fn try_insert_str<S: AsRef<str>>(
    &mut self,
    index: usize,
    string: S
) -> Result<(), StringError>

Inserts string at index, shifting any values that exist in positions greater than index to the right.

Returns StringError::OutOfBounds if self.len() + string.len() exceeds the total capacity of the StaticString and StringError::NotCharBoundary if index does not lie at a valid UTF-8 character boundary.

Example usage:

let mut string = StaticString::<20>::try_from_str("ABCD🤔")?;
string.try_insert_str(1, "AB")?;
string.try_insert_str(1, "BC")?;
assert!(string.try_insert_str(1, "0".repeat(20)).unwrap_err().is_out_of_bounds());
assert_eq!(string.as_str(), "ABCABBCD🤔");
assert!(string.try_insert_str(20, "C").unwrap_err().is_not_char_boundary());
assert!(string.try_insert_str(10, "D").unwrap_err().is_not_char_boundary());

pub const fn len(&self) -> usize

Returns the current length of the StaticString.

Example usage:

let mut s = StaticString::<20>::from("ABCD");
assert_eq!(s.len(), 4);
s.push('🤔');
assert_eq!(s.len(), 8);

pub const fn is_empty(&self) -> bool

Returns true if the StaticString has a current length of 0.

Example usage:

let mut s = StaticString::<20>::try_from_str("ABCD")?;
assert!(!s.is_empty());
s.clear();
assert!(s.is_empty());

pub const fn is_full(&self) -> bool

Returns true if the StaticString's length is equal to its capacity.

Example usage:

let mut s = StaticString::<4>::try_from_str("ABCD")?;
assert!(s.is_full());
s.clear();
assert!(!s.is_full());

pub fn split_off(&mut self, at: usize) -> Self

Splits the StaticString in two if at is less than the its current length.

The original StaticString will contain elements 0..at, and the new one will contain elements at..self.len().

Panics if at is greater than the length of the StaticString or if it does not lie at a valid UTF-8 character boundary.

Example usage:

let mut ab = StaticString::<4>::from("ABCD");
let cd = ab.split_off(2);
assert_eq!(ab, "AB");
assert_eq!(cd, "CD");

pub fn clear(&mut self)

Removes all contents from the StaticString and sets its length back to zero.

Example usage:

let mut s = StaticString::<20>::try_from_str("ABCD")?;
assert!(!s.is_empty());
s.clear();
assert!(s.is_empty());

pub fn replace_range<S: AsRef<str>, R: RangeBounds<usize>>(
    &mut self,
    range: R,
    with: S
)

Removes the specified range from the StaticString and replaces it with the provided input (which does not need to have the same length as the range being removed), panicking if either the high or low bounds of the range exceed self.len() or do not lie at valid UTF-8 character boundaries.

Example usage:

let mut s = StaticString::<20>::from("ABCD🤔");
s.replace_range(2..4, "EFGHI");
assert_eq!(s.as_str(), "ABEFGHI🤔");

Trait Implementations

impl<'_, const N: usize> Add<&'_ str> for StaticString<N>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &str) -> Self::Output

Performs the + operation.

impl<'_, const N: usize> AddAssign<&'_ str> for StaticString<N>

fn add_assign(&mut self, other: &str)

Performs the += operation.

impl<const N: usize> AsMut<str> for StaticString<N>

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

Performs the conversion.

impl<const N: usize> AsRef<[u8]> for StaticString<N>

fn as_ref(&self) -> &[u8]

Performs the conversion.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<const N: usize> Borrow<str> for StaticString<N>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<const N: usize> BorrowMut<str> for StaticString<N>

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

Mutably borrows from an owned value.

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

fn clone(&self) -> StaticString<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 StaticString<N>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the "default value" for a type.

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

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<const N: usize> DerefMut for StaticString<N>

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

impl<'a, const N: usize> Extend<&'a char> for StaticString<N>

fn extend<I: IntoIterator<Item = &'a char>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

impl<'a, const N: usize> Extend<&'a str> for StaticString<N>

fn extend<I: IntoIterator<Item = &'a str>>(&mut self, iterable: I)

Extends a collection with the contents of an iterator.

impl<const N: usize> Extend<char> for StaticString<N>

fn extend<I: IntoIterator<Item = char>>(&mut self, iterable: I)

Extends a collection with the contents of an iterator.

impl<'a, const N: usize> From<&'a str> for StaticString<N>

fn from(s: &str) -> Self

Performs the conversion.

impl<const N: usize> From<StaticString<N>> for StaticVec<u8, N>

fn from(string: StaticString<N>) -> Self

Performs the conversion.

impl<const N1: usize, const N2: usize> From<StaticString<N1>> for StaticVec<u8, N2>

default fn from(string: StaticString<N1>) -> Self

Performs the conversion.

impl<const N: usize> From<StaticVec<u8, N>> for StaticString<N>

fn from(vec: StaticVec<u8, N>) -> Self

Performs the conversion.

impl<const N1: usize, const N2: usize> From<StaticVec<u8, N1>> for StaticString<N2>

default fn from(vec: StaticVec<u8, N1>) -> Self

Performs the conversion.

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

fn from(string: String) -> Self

Performs the conversion.

impl<'a, const N: usize> FromIterator<&'a char> for StaticString<N>

fn from_iter<I: IntoIterator<Item = &'a char>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, const N: usize> FromIterator<&'a str> for StaticString<N>

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Creates a value from an iterator.

impl<const N: usize> FromIterator<char> for StaticString<N>

fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, const N: usize> FromStr for StaticString<N>

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

fn hash<H: Hasher>(&self, hasher: &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> Index<Range<usize>> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> Index<RangeFrom<usize>> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> Index<RangeFull> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> Index<RangeInclusive<usize>> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> Index<RangeTo<usize>> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> Index<RangeToInclusive<usize>> for StaticString<N>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const N: usize> IndexMut<Range<usize>> for StaticString<N>

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

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

impl<const N: usize> IndexMut<RangeFrom<usize>> for StaticString<N>

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

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

impl<const N: usize> IndexMut<RangeFull> for StaticString<N>

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

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

impl<const N: usize> IndexMut<RangeInclusive<usize>> for StaticString<N>

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

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

impl<const N: usize> IndexMut<RangeTo<usize>> for StaticString<N>

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

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

impl<const N: usize> IndexMut<RangeToInclusive<usize>> for StaticString<N>

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

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

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

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_, const N: usize> PartialEq<&'_ str> for StaticString<N>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, const N: usize> PartialOrd<&'_ str> for StaticString<N>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> PartialOrd<StaticString<N>> for StaticString<N>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> PartialOrd<String> for StaticString<N>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> PartialOrd<str> for StaticString<N>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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> Write for StaticString<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

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.