Struct ConstString

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

A string with a fixed-capacity array as storage to be used in compile-time constants.

Causes an unfriendly compile-time error when the size of the string exceeds its capacity.

This struct always upholds that it contains valid utf-8.

Implementations

impl<const N: usize> ConstString<N>

pub const unsafe fn from_bytes(slice: &[u8]) -> Self

Creates a new ConstString from a slice of bytes.

Will return [ConstString::ErrTooLong] if the array is longer than the capacity of the ConstString.

Safety

The slice must contain valid utf-8.

Panics

If the length of the slice exceeds the capacity of the array.

pub const fn from_str(string: &str) -> Self

Creates a new ConstString from a &str.

Panics

If the length of the string exceeds the capacity of the array.

pub const unsafe fn with_bytes(self, other: &[u8]) -> Self

Extends the array in a ConstString by value with a slice of bytes.

Safety

The slice must contain valid utf-8.

Panics

If the length of the string exceeds the remaining space in the array.

pub const fn with_str(self, other: &str) -> Self

Extends the array in a ConstString by value with a string slice.

pub const fn with<const M: usize>(self, other: ConstString<M>) -> Self

Extends the array in a ConstString by value with another ConstString.

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

Returns the string in this ConstString as an &str

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

fn eq(&self, other: &ConstString<N>) -> 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 N: usize> Copy for ConstString<N>

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