Struct GraphemeU8

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

An EGC backed by an StringU8.

Implementations

impl<const CAP: usize> GraphemeU8<CAP>

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

Creates a new empty GraphemeU8.

Errors

Returns MismatchedCapacity if `CAP > 255.

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

Available on crate feature _char7 only.

Creates a new GraphemeU8 from a char7.

Errors

Returns MismatchedCapacity if `CAP > 255.

Will always succeed if CAP >= 1 and <= 255.

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

Available on crate feature _char8 only.

Creates a new GraphemeU8 from a char8.

Errors

Returns MismatchedCapacity if CAP > 255 or < c.len_utf8().

Will always succeed if CAP >= 2 and <= 255.

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

Available on crate feature _char16 only.

Creates a new GraphemeU8 from a char16.

Errors

Returns MismatchedCapacity if CAP > 255 or < c.len_utf8().

Will always succeed if CAP >= 3 and <= 255.

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

Creates a new GraphemeU8 from a char.

Errors

Returns MismatchedCapacity if CAP > 255 or < c.len_utf8().

Will never panic if CAP >= 4 and <= 255.

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 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 unsafe fn as_bytes_mut(&mut self) -> &mut [u8]

Available on crate feature unsafe_slice only.

Returns a mutable byte slice of the inner string slice.

Safety

The content must be valid UTF-8.

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 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) -> IterChars<'_>

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.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

const DEFAULT: Self

Returns an empty string.

Panics

Panics if CAP > 255.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns an empty extended grapheme character.

Panics

Panics if CAP > 255.

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

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

Formats the value using the given formatter.

impl<const CAP: usize> Hash for GraphemeU8<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> PartialEq for GraphemeU8<CAP>

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

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

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