Struct ThreeByteSequence 

pub struct ThreeByteSequence { /* private fields */ }

Three-byte UTF-8 sequence

Implementations

impl ThreeByteSequence

pub const LEN: usize = 3

The number of bytes in this kind of UTF-8 sequence.

pub const fn is_with_prepared(prepared: PreparedThreeBytes) -> bool

Whether prepared forms a well-formed three-byte UTF-8 sequence.

Safety-usable invariant

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

pub const fn is(first: u8, second: u8, third: u8) -> bool

Whether the bytes form a well-formed three-byte UTF-8 sequence.

Safety-usable invariant

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

pub const unsafe fn new_unchecked(first: u8, second: u8, third: u8) -> Self

Unchecked constructor

Safety

first, second, and third must form a three-byte UTF-8 sequence.

Panics

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

pub const fn try_new( first: u8, second: u8, third: u8, ) -> Result<Self, Utf8ByteError>

Fallible constructor

Ok if first, second, and third form a three-byte UTF-8 sequence and Err otherwise.

pub const fn try_new_with_prepared( prepared: PreparedThreeBytes, ) -> Result<Self, Utf8ByteError>

Fallible constructor with prepared bytes

Ok if the prepared bytes form a three-byte UTF-8 sequence and Err otherwise.

pub const fn to_typed_bytes( self, ) -> (LeadForThreeByte, UnconstrainedContinuation, UnconstrainedContinuation)

Convert to typed byte tuple.

Safety-usable invariant

The tuple represents a well-formed three-byte UTF-8 sequence. In particular, the value of the second tuple item is within the permissible range given the value of the first tuple item.

pub const fn to_char(self) -> char

Convert to char

pub const fn as_bytes(&self) -> &[u8; 3]

View as &[u8; 3]

Safety-usable invariant

The bytes form a single well-formed three-byte UTF-8 sequence.

pub const fn as_str(&self) -> &str

View as &str

Safety-usable invariant

The string slice contains a single three-byte UTF-8 sequence.

Trait Implementations

impl AsRef<str> for ThreeByteSequence

fn as_ref(&self) -> &str

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

impl Clone for ThreeByteSequence

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 ThreeByteSequence

impl Debug for ThreeByteSequence

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

Formats the value using the given formatter.

impl Eq for ThreeByteSequence

impl From<ThreeByteSequence> for char

fn from(three_byte: ThreeByteSequence) -> Self

Converts to this type from the input type.

impl Hash for ThreeByteSequence

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 ThreeByteSequence

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 ThreeByteSequence

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ThreeByteSequence

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 ThreeByteSequence

impl Utf8ByteSequence for ThreeByteSequence