Struct Surrogate 

pub struct Surrogate { /* private fields */ }

A single surrogate code unit, which can be a high surrogate or a low surrogate

Implementations

impl Surrogate

pub const MIN: Self

Minimum possible value.

pub const MAX: Self

Maximum possible value.

pub const fn is(code_unit: u16) -> bool

Whether code_unit is a surrogate.

Safety-usable invariant

Iff this method returns true, the safety invariant of new_unchecked() is satisfied.

pub const unsafe fn new_unchecked(code_unit: u16) -> Self

Unchecked constructor

Safety

The caller must ensure that code_unit is in the range 0xD800..=0xDFFF.

Panics

When debug assertions are enabled, panics if the safety invariant is not upheld.

pub const fn try_new(code_unit: u16) -> Result<Self, Utf16CodeUnitError>

Fallible constructor

Ok if surrogate and Err otherwise.

pub const fn to_u16(self) -> u16

Convert to plain code unit

Trait Implementations

impl Clone for Surrogate

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 Surrogate

impl Debug for Surrogate

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

Formats the value using the given formatter.

impl Eq for Surrogate

impl From<Surrogate> for u16

fn from(surrogate: Surrogate) -> Self

Converts to this type from the input type.

impl Hash for Surrogate

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 Surrogate

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 Surrogate

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Surrogate

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 Surrogate

impl TryFrom<u16> for Surrogate

type Error = Utf16CodeUnitError

The type returned in the event of a conversion error.

fn try_from(code_unit: u16) -> Result<Self, Utf16CodeUnitError>

Performs the conversion.