Struct Codepoint

pub struct Codepoint(/* private fields */);

A single Unicode codepoint.

This type’s string representation is a hexadecimal number. It is guaranteed to be in the range [0, 10FFFF].

Note that unlike Rust’s char type, this may be a surrogate codepoint.

Implementations

impl Codepoint

pub fn from_u32(n: u32) -> Result<Codepoint, Error>

Create a new codepoint from a u32.

If the given number is not a valid codepoint, then this returns an error.

pub fn value(self) -> u32

Return the underlying u32 codepoint value.

pub fn scalar(self) -> Option<char>

Attempt to convert this codepoint to a Unicode scalar value.

If this is a surrogate codepoint, then this returns None.

Trait Implementations

impl Clone for Codepoint

fn clone(&self) -> Codepoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Codepoint

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

Formats the value using the given formatter.

impl Default for Codepoint

fn default() -> Codepoint

Returns the “default value” for a type.

impl Display for Codepoint

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

Formats the value using the given formatter.

impl FromStr for Codepoint

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Codepoint, Error>

Parses a string s to return a value of this type.

impl Hash for Codepoint

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 IntoIterator for Codepoint

type IntoIter = CodepointIter

Which kind of iterator are we turning this into?

type Item = Codepoint

The type of the elements being iterated over.

fn into_iter(self) -> CodepointIter

Creates an iterator from a value.

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<Codepoint> for Codepoints

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 PartialEq<Codepoint> for u32

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 PartialEq<u32> for Codepoint

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

impl Copy for Codepoint

impl Eq for Codepoint

impl StructuralPartialEq for Codepoint