Struct StaticNonNulString

pub struct StaticNonNulString<const CAP: usize> { /* private fields */ }

A UTF-8-encoded string, backed by an array of constant capacity. Can’t contain nul chars.

Internally, the first 0 byte in the array indicates the end of the string.

Implementations

impl<const CAP: usize> StaticNonNulString<CAP>

pub const fn new() -> Self

Creates a new empty StaticNonNulString.

pub const fn from_char7(c: Char7) -> Self

Creates a new StaticNonNulString from a Char7.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < 1

Will never panic if CAP >= 1.

pub const fn from_char8(c: Char8) -> Self

Creates a new StaticU8String from a Char8.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < c.len_utf8().

Will never panic if CAP >= 2.

pub const fn from_char16(c: Char16) -> Self

Creates a new StaticU8String from a Char16.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < c.len_utf8().

Will never panic if CAP >= 3.

pub const fn from_char24(c: Char24) -> Self

Creates a new StaticU8String from a Char24.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < c.len_utf8().

Will never panic if CAP >= 4.

pub const fn from_char32(c: Char32) -> Self

Creates a new StaticU8String from a Char32.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < c.len_utf8().

Will never panic if CAP is >= 4.

pub const fn from_char(c: char) -> Self

Creates a new StaticU8String from a char.

If c.is_nul() an empty string will be returned.

Panic

Panics if !c.is_nul() and CAP < c.len_utf8().

Will never panic if CAP is >= 4.

pub const fn capacity() -> usize

Returns the total capacity in bytes.

pub fn remaining_capacity(&self) -> usize

Returns the remaining capacity.

pub fn len(&self) -> usize

Returns the current length.

pub fn is_empty(&self) -> bool

Returns true if the current length is 0.

pub fn is_full(&self) -> bool

Returns true if the current remaining capacity is 0.

pub fn clear(&mut self)

Sets the length to 0, by resetting all bytes to 0.

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

Returns a byte slice of the inner string slice.

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

Available on crate feature unsafe only.

Returns a mutable byte slice of the inner string slice.

pub const fn as_array(&self) -> [u8; CAP]

Returns a copy of the inner array with the full contents.

The array contains all the bytes, including those outside the current length.

pub const fn into_array(self) -> [u8; CAP]

Returns the inner array with the full contents.

The array contains all the bytes, including those outside the current length.

pub fn as_str(&self) -> &str

Returns the inner string slice.

pub unsafe fn as_str_mut(&mut self) -> &mut str

Available on crate feature unsafe only.

Returns the mutable inner string slice.

pub fn chars(&self) -> Chars<'_>

Available on crate feature alloc only.

Returns an iterator over the chars of this grapheme cluster.

pub fn to_cstring(&self) -> CString

Available on crate feature alloc only.

Returns a new allocated C-compatible, nul-terminanted string.

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

Removes the last character and returns it, or None if the string is empty.

pub fn try_pop(&mut self) -> Result<char>

Tries to remove the last character and return it.

Errors

Returns an error if the string is empty.

pub fn pop_unchecked(&mut self) -> char

Removes the last character and returns it.

Panics

Panics if the string is empty.

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

Appends to the end of the string the given character.

Returns the number of bytes written.

It will return 0 bytes if the given character doesn’t fit in the remaining capacity, or if it is the nul character.

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

Tries to append to the end of the string the given character.

Returns the number of bytes written.

Trying to push a nul character does nothing and returns 0 bytes.

Errors

Returns an error if the capacity is not enough to hold the given character.

pub fn push_str(&mut self, string: &str) -> usize

Appends to the end the fitting characters from the given string slice.

Nul characters will be stripped out.

Returns the number of bytes written, which will be 0 if not even the first non-nul character can fit.

pub fn try_push_str(&mut self, string: &str) -> Result<usize>

Tries to append to the end the fitting characters from the given string slice.

Nul characters will be stripped out.

Returns the number of bytes written.

Errors

Returns an error if the capacity is not enough to hold even the first non-nul character.

pub fn try_push_str_complete(&mut self, string: &str) -> Result<usize>

Tries to append the complete string slice to the end.

Returns the number of bytes written in success.

Nul characters will not be taken into account.

Errors

Returns an error if the slice wont completely fit.

Trait Implementations

impl<const CAP: usize> Clone for StaticNonNulString<CAP>

fn clone(&self) -> StaticNonNulString<CAP>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const CAP: usize> Debug for StaticNonNulString<CAP>

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

Formats the value using the given formatter.

impl<const CAP: usize> Default for StaticNonNulString<CAP>

fn default() -> Self

Returns an empty string.

impl<const CAP: usize> Display for StaticNonNulString<CAP>

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

Formats the value using the given formatter.

impl<const CAP: usize> Hash for StaticNonNulString<CAP>

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 CAP: usize> Ord for StaticNonNulString<CAP>

fn cmp(&self, other: &StaticNonNulString<CAP>) -> 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 CAP: usize> PartialEq for StaticNonNulString<CAP>

fn eq(&self, other: &StaticNonNulString<CAP>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const CAP: usize> PartialOrd for StaticNonNulString<CAP>

fn partial_cmp(&self, other: &StaticNonNulString<CAP>) -> 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<const CAP: usize> Copy for StaticNonNulString<CAP>

impl<const CAP: usize> Eq for StaticNonNulString<CAP>

impl<const CAP: usize> StructuralPartialEq for StaticNonNulString<CAP>