Struct GraphemeNonul 

pub struct GraphemeNonul<const CAP: usize>(/* private fields */);

𝐓 An EGC backed by a StringNonul.

Implementations

impl<const CAP: usize> GraphemeNonul<CAP>

pub const fn new() -> Result<GraphemeNonul<CAP>, MismatchedCapacity>

Creates a new empty GraphemeNonul.

Errors

Returns MismatchedCapacity if CAP > 255.

pub const fn from_char7( c: char7, ) -> Result<GraphemeNonul<CAP>, MismatchedCapacity>

Creates a new GraphemeNonul from a char7.

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

Errors

Returns MismatchedCapacity if CAP > 255, or if !c.is_nul() and CAP < 1.

Will always succeed if CAP >= 1.

pub const fn from_char8( c: char8, ) -> Result<GraphemeNonul<CAP>, MismatchedCapacity>

Creates a new GraphemeNonul from a char8.

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

Errors

Returns MismatchedCapacity if CAP > 255, or if !c.is_nul() and CAP < c.len_utf8().

Will always succeed if CAP >= 2.

pub const fn from_char16( c: char16, ) -> Result<GraphemeNonul<CAP>, MismatchedCapacity>

Creates a new GraphemeNonul from a char16.

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

Errors

Returns MismatchedCapacity if CAP > 255, or if !c.is_nul() and CAP < c.len_utf8().

Will always succeed if CAP >= 3.

pub const fn from_char( c: char, ) -> Result<GraphemeNonul<CAP>, MismatchedCapacity>

Creates a new GraphemeNonul from a char.

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

Errors

Returns MismatchedCapacity if CAP > 255, or if !c.is_nul() and CAP < c.len_utf8().

Will always succeed if CAP >= 4.

pub const fn len(&self) -> usize

Returns the length in bytes.

pub const fn is_empty(&self) -> bool

Returns true if the current length is 0.

pub const fn capacity() -> usize

Returns the total capacity in bytes.

pub const fn remaining_capacity(&self) -> usize

Returns the remaining capacity.

pub const fn is_full(&self) -> bool

Returns true if the current remaining capacity is 0.

pub const fn clear(&mut self)

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

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

Returns a byte slice of the inner string slice.

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

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 const fn as_str(&self) -> &str

Returns the inner string slice.

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

Available on crate feature unsafe_slice only.

Returns the mutable inner string slice.

Safety

The content must be valid UTF-8.

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

Returns an iterator over the chars of this grapheme cluster.

Trait Implementations

impl<const LEN: usize> BitSized<LEN> for GraphemeNonul<LEN>

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const CAP: usize> ConstDefault for GraphemeNonul<CAP>

const DEFAULT: Self

Returns an empty string.

#Panics

Panics if CAP > u8::MAX.

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

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

Formats the value using the given formatter.

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

fn default() -> GraphemeNonul<CAP>

Returns an empty extended grapheme character.

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

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

Formats the value using the given formatter.

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

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 GraphemeNonul<CAP>

fn cmp(&self, other: &GraphemeNonul<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 GraphemeNonul<CAP>

fn eq(&self, other: &GraphemeNonul<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 GraphemeNonul<CAP>

fn partial_cmp(&self, other: &GraphemeNonul<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> Eq for GraphemeNonul<CAP>

impl<const CAP: usize> Grapheme for GraphemeNonul<CAP>

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