Struct CodePoint 

#[doc(hidden)] pub struct CodePoint(CodePointInner);

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

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).

Tuple Fields

0: CodePointInner

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

Implementations

impl CodePoint

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

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

Unsafely creates a new CodePoint without checking the value.

Only use when value is known to be less than or equal to 0x10FFFF.

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

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

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

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

Creates a new CodePoint from a char.

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

pub fn to_u32(&self) -> u32

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

Returns the numeric value of the code point.

pub fn to_lead_surrogate(&self) -> Option<u16>

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

Returns the numeric value of the code point if it is a leading surrogate.

pub fn to_trail_surrogate(&self) -> Option<u16>

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

Returns the numeric value of the code point if it is a trailing surrogate.

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

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

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

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

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).

Trait Implementations

impl Clone for CodePoint

fn clone(&self) -> CodePoint

Returns a duplicate of the value.

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

where Self:,

Performs copy-assignment from source.

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

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

impl Hash for CodePoint

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

Feeds this value into the given Hasher.

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)

where Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CodePoint

fn cmp(&self, other: &CodePoint) -> 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 PartialEq for CodePoint

fn eq(&self, other: &CodePoint) -> 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 PartialOrd for CodePoint

fn partial_cmp(&self, other: &CodePoint) -> 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.

#[doc(hidden)] fn __chaining_lt(&self, other: &Rhs) -> ControlFlow<bool>

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

If self == other, returns ControlFlow::Continue(()). Otherwise, returns ControlFlow::Break(self < other).

#[doc(hidden)] fn __chaining_le(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for <= instead of <.

#[doc(hidden)] fn __chaining_gt(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for > instead of <.

#[doc(hidden)] fn __chaining_ge(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for >= instead of <.

impl Copy for CodePoint

impl StructuralPartialEq for CodePoint