Struct const_base::ArrayStr

#[repr(transparent)]
pub struct ArrayStr<const N: usize> { /* private fields */ }

A utf-8 byte array

Example

use const_base::ArrayStr;

static ARR_STR: ArrayStr<12> = ArrayStr::from_utf8_unwrap(*b"hello world!");

assert_eq!(ARR_STR.as_str(), "hello world!");
assert_eq!(ARR_STR, "hello world!");

Implementations

impl<const N: usize> ArrayStr<N>

pub const fn from_utf8(arr: [u8; N]) -> Result<Self, Utf8Error>

Constructs an ArrayStr, returning an error if arr isn’t valid utf-8.

pub const fn from_utf8_unwrap(arr: [u8; N]) -> Self

Constructs an ArrayStr

Panics

Panics if arr isn’t valid utf-8.

pub const unsafe fn from_utf8_unchecked(arr: [u8; N]) -> Self

Constructs an ArrayStr

Safety

arr must be valid utf-8.

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

Gets a reference to the wrapped byte array.

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

Gets a slice of the wrapped byte array.

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

Unwraps this into the wrapped byte array.

impl<const N: usize> ArrayStr<N>

pub const fn len(&self) -> usize

Gets the length of this array string.

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

Gets a string slice of the entire array string.

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<const N: usize> PartialEq<&str> for ArrayStr<N>

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

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

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

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

impl<const N: usize> PartialEq<ArrayStr<N>> for &str

fn eq(&self, rhs: &ArrayStr<N>) -> bool

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

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

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

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

fn eq(&self, other: &ArrayStr<N>) -> bool

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

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

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

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

fn eq(&self, rhs: &ArrayStr<N>) -> bool

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

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

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

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

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

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

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

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

impl<const N: usize> Copy for ArrayStr<N>

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

impl<const N: usize> StructuralEq for ArrayStr<N>

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