Struct SurrogatePair 

pub struct SurrogatePair { /* private fields */ }

A two-code-unit UTF-16 sequence

A high surrogate followed by a low surrogate representing a Unicode scalar value outside the Basic Multilingual Plane.

Implementations

impl SurrogatePair

pub const fn new(high: HighSurrogate, low: LowSurrogate) -> Self

Constructor from a high surrogate and a low surrogate

pub const fn to_typed_code_units(self) -> (HighSurrogate, LowSurrogate)

Convert to typed code unit tuple.

pub const fn to_char(self) -> char

Convert to char

pub const fn as_code_units(&self) -> &[u16; 2]

View as &[u16; 2]

Safety-usable invariant

The array contains a single well-formed surrogate pair.

pub const fn as_slice(&self) -> &[u16]

View as &[u16]

Safety-usable invariant

The slice contains a single well-formed surrogate pair.

Trait Implementations

impl AsRef<[u16]> for SurrogatePair

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SurrogatePair

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SurrogatePair

impl Debug for SurrogatePair

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

Formats the value using the given formatter.

impl Eq for SurrogatePair

impl From<SurrogatePair> for char

fn from(surrogate_pair: SurrogatePair) -> Self

Converts to this type from the input type.

impl Hash for SurrogatePair

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 Ord for SurrogatePair

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for SurrogatePair

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SurrogatePair

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for SurrogatePair

impl Utf16CodeUnitSequence for SurrogatePair