Struct wtf8_rs::CodePoint

pub struct CodePoint { /* fields omitted */ }

A Unicode code point: from U+0000 to U+10FFFF.

Compares with the char type, which represents a Unicode scalar value: a code point that is not a surrogate (U+D800 to U+DFFF).

Implementations

impl CodePoint

pub unsafe fn from_u32_unchecked(value: u32) -> CodePoint

Unsafely creates a new CodePoint without checking the value.

Safety

Only safe if value is less than or equal to 0x10FFFF.

pub fn from_u32(value: u32) -> Option<CodePoint>

Creates a new CodePoint if the value is a valid code point.

Returns None if value is above 0x10FFFF.

pub fn from_char(value: char) -> CodePoint

Creates a new CodePoint from a char.

Since all Unicode scalar values are code points, this always succeeds.

pub fn to_u32(&self) -> u32

Returns the numeric value of the code point.

pub fn to_char(&self) -> Option<char>

Optionally returns a Unicode scalar value for the code point.

Returns None if the code point is a surrogate (from U+D800 to U+DFFF).

pub fn to_char_lossy(&self) -> char

Returns a Unicode scalar value for the code point.

Returns '\u{FFFD}' (the replacement character “�”) if the code point is a surrogate (from U+D800 to U+DFFF).

pub fn decode_utf16<I>(input: I) -> DecodeUtf16<I> where
    I: Iterator<Item = u16>, 

Decode potentially ill-formed UTF-16.

pub fn encode_utf16<I>(input: I) -> EncodeUtf16<I> where
    I: Iterator<Item = CodePoint>, 

Encode potentially ill-formed UTF-16.

Trait Implementations

impl Clone for CodePoint

fn clone(&self) -> CodePoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CodePoint

impl Debug for CodePoint

Format the code point as U+ followed by four to six hexadecimal digits. Example: U+1F4A9

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

Formats the value using the given formatter.

impl Eq for CodePoint

impl<'a> Extend<&'a CodePoint> for Wtf8Buf

fn extend<T: IntoIterator<Item = &'a CodePoint>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<CodePoint> for Wtf8Buf

Append code points from an iterator to the string.

This replaces surrogate code point pairs with supplementary code points, like concatenating ill-formed UTF-16 strings effectively would.

fn extend<T: IntoIterator<Item = CodePoint>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<char> for CodePoint

fn from(c: char) -> Self

Performs the conversion.

impl<'a> FromIterator<&'a CodePoint> for Wtf8Buf

fn from_iter<T: IntoIterator<Item = &'a CodePoint>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl FromIterator<CodePoint> for Wtf8Buf

Creates a new WTF-8 string from an iterator of code points.

This replaces surrogate code point pairs with supplementary code points, like concatenating ill-formed UTF-16 strings effectively would.

fn from_iter<T: IntoIterator<Item = CodePoint>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl Ord for CodePoint

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CodePoint> for CodePoint

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

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

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

This method tests for !=.

impl PartialOrd<CodePoint> for CodePoint

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

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

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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 StructuralEq for CodePoint

impl StructuralPartialEq for CodePoint