Struct encode_unicode::Utf8Char

pub struct Utf8Char { /* fields omitted */ }

Store a char as UTF-8 so it can be borrowed as a str

Has the same size as char, and is a [u8;4] with the invariant that the first nth bytes are valid UTF-8, and the remaining are zero.

Methods

impl Utf8Char

pub fn from_slice_start(src: &[u8]) -> Result<(Self, usize), InvalidUtf8Slice>

Validate the start of a UTF-8 slice and store it. Also returns how many bytes were needed.

If it's a str and you know it contains only one codepoint, use .from_str() to skip the validation.

pub fn from_array(utf8: [u8; 4]) -> Result<Self, InvalidUtf8Array>

Validate the array and store it.

pub fn len(self) -> usize

Result is 1...4 and identical to .as_ref().len() or .as_char().len_utf8(). There is no .is_emty() because it would always return false.

pub fn to_char(self) -> char

Convert from UTF-8 to UTF-32

pub fn to_slice(self, dst: &mut [u8]) -> Option<usize>

Write the internal representation to a slice, and then returns the number of bytes written.

None is returned if the buffer is too small; then the buffer is left unmodified. A buffer of length four is always large enough.

pub fn to_array(self) -> ([u8; 4], usize)

Expose the internal array and the number of used bytes.

Trait Implementations

impl PartialEq<Utf8Char> for Utf8Char

fn eq(&self, other: &Utf8Char) -> bool

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

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

This method tests for !=.

impl AsRef<[u8]> for Utf8Char

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<str> for Utf8Char

fn as_ref(&self) -> &str

Performs the conversion.

impl IntoIterator for Utf8Char

type Item = u8

The type of the elements being iterated over.

type IntoIter = Utf8Iterator

Which kind of iterator are we turning this into?

Important traits for Utf8Iterator

impl Iterator for Utf8Iterator type Item = u8;impl Read for Utf8Iterator

fn into_iter(self) -> Utf8Iterator

Iterate over the byte values.

impl Default for Utf8Char

fn default() -> Utf8Char

Returns the "default value" for a type.

impl Ord for Utf8Char

fn cmp(&self, other: &Utf8Char) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for Utf8Char

fn clone(&self) -> Utf8Char

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<char> for Utf8Char

fn from(c: char) -> Self

Performs the conversion.

impl From<Utf8Char> for char

fn from(uc: Utf8Char) -> char

Performs the conversion.

impl From<Utf8Char> for Utf8Iterator

fn from(uc: Utf8Char) -> Self

Performs the conversion.

impl Eq for Utf8Char

impl Copy for Utf8Char

impl PartialOrd<Utf8Char> for Utf8Char

fn partial_cmp(&self, other: &Utf8Char) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Utf8Char) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Utf8Char) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Utf8Char) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Utf8Char) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Utf8Char

fn fmt(&self, fmtr: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Hash for Utf8Char

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, 

Feeds a slice of this type into the given [Hasher].

impl Deref for Utf8Char

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl FromStr for Utf8Char

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FromStrError>

The string must contain exactly one codepoint

impl Borrow<[u8]> for Utf8Char

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Borrow<str> for Utf8Char

fn borrow(&self) -> &str

Immutably borrows from an owned value.