Struct encode_unicode::Utf16Char

pub struct Utf16Char { /* fields omitted */ }

Store a char as UTF-16 so it can be borrowed as a slice

Size is identical to char. Cannot represent all 2^32-1 possible values, but can do all valid ones.

Methods

impl Utf16Char

pub fn from_slice(src: &[u16]) -> Result<(Self, usize), InvalidUtf16Slice>

Validate and store the first UTF-16 codepoint in the slice. Also return how many units were needed.

pub fn from_tuple(utf16: (u16, Option<u16>)) -> Result<Self, InvalidUtf16Tuple>

Validate and store a UTF-16 pair as returned from char.to_utf16_tuple().

pub fn len(self) -> usize

Returns 1 or 2. There is no .is_emty() because it would always return false.

pub fn to_char(self) -> char

Convert from UTF-16 to UTF-32

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

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

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

pub fn to_tuple(self) -> (u16, Option<u16>)

The second u16 is used for surrogate pairs.

Trait Implementations

impl PartialEq<Utf16Char> for Utf16Char

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

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

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

This method tests for !=.

impl AsRef<[u16]> for Utf16Char

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

Performs the conversion.

impl IntoIterator for Utf16Char

type Item = u16

The type of the elements being iterated over.

type IntoIter = Utf16Iterator

Which kind of iterator are we turning this into?

Important traits for Utf16Iterator

impl Iterator for Utf16Iterator type Item = u16;

fn into_iter(self) -> Utf16Iterator

Iterate over the units.

impl Default for Utf16Char

fn default() -> Utf16Char

Returns the "default value" for a type.

impl Ord for Utf16Char

fn cmp(&self, rhs: &Self) -> 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 Utf16Char

fn clone(&self) -> Utf16Char

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<char> for Utf16Char

fn from(c: char) -> Self

Performs the conversion.

impl From<Utf16Char> for char

fn from(uc: Utf16Char) -> char

Performs the conversion.

impl From<Utf16Char> for Utf16Iterator

fn from(uc: Utf16Char) -> Self

Performs the conversion.

impl Eq for Utf16Char

impl Copy for Utf16Char

impl PartialOrd<Utf16Char> for Utf16Char

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Debug for Utf16Char

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

Formats the value using the given formatter.

impl Hash for Utf16Char

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 Utf16Char

type Target = [u16]

The resulting type after dereferencing.

fn deref(&self) -> &[u16]

Dereferences the value.

impl Borrow<[u16]> for Utf16Char

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

Immutably borrows from an owned value.