Enum LeadForFourByte 

#[repr(u8)]
pub enum LeadForFourByte {
    Bf0 = 240,
    Bf1 = 241,
    Bf2 = 242,
    Bf3 = 243,
    Bf4 = 244,
}

A lead byte for a four-byte UTF-8 sequence (0xF0 to 0xF4, inclusive)

Variants

Bf0 = 240

Bf1 = 241

Bf2 = 242

Bf3 = 243

Bf4 = 244

Implementations

impl LeadForFourByte

pub const MIN: Self = Self::Bf0

Minimum possible value.

pub const MAX: Self = Self::Bf4

Maximum possible value.

pub const fn is(byte: u8) -> bool

Whether byte is in range for this type.

Safety-usable invariant

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

pub const unsafe fn new_unchecked(lead: u8) -> Self

Unchecked constructor

Safety

lead must be in the range 0xF0 to 0xF4, inclusive.

Panics

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

pub const fn try_new(byte: u8) -> Result<Self, Utf8ByteError>

Fallible constructor

Ok if in the range 0xF0 to 0xF4, inclusive, and Err otherwise.

pub const fn to_u8(self) -> u8

Convert to plain byte

pub const fn to_non_ascii(self) -> NonAscii

Convert to NonAscii

pub const fn to_lead_for_multi_byte(self) -> LeadForMultiByte

Convert to LeadForMultiByte

pub const fn low_three(self) -> u8

Obtain the least-significant three bits (i.e. the non-tag bits).

Safety-usable invariant

Only the least-significant three bits can have non-zero values.

pub const fn low_three_u32(self) -> u32

Obtain the least-significant three bits (i.e. the non-tag bits) as u32.

Safety-usable invariant

Only the least-significant three bits can have non-zero values.

Trait Implementations

impl Clone for LeadForFourByte

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 LeadForFourByte

impl Debug for LeadForFourByte

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

Formats the value using the given formatter.

impl Eq for LeadForFourByte

impl From<LeadForFourByte> for u8

fn from(lead: LeadForFourByte) -> Self

Converts to this type from the input type.

impl From<LeadForFourByte> for NonAscii

fn from(lead: LeadForFourByte) -> Self

Converts to this type from the input type.

impl From<LeadForFourByte> for LeadForMultiByte

fn from(lead: LeadForFourByte) -> Self

Converts to this type from the input type.

impl Hash for LeadForFourByte

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 LeadForFourByte

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 LeadForFourByte

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LeadForFourByte

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 LeadForFourByte

impl TryFrom<LeadForMultiByte> for LeadForFourByte

type Error = Utf8ByteError

The type returned in the event of a conversion error.

fn try_from(lead: LeadForMultiByte) -> Result<Self, Utf8ByteError>

Performs the conversion.

impl TryFrom<NonAscii> for LeadForFourByte

type Error = Utf8ByteError

The type returned in the event of a conversion error.

fn try_from(non_ascii: NonAscii) -> Result<Self, Utf8ByteError>

Performs the conversion.

impl TryFrom<u8> for LeadForFourByte

type Error = Utf8ByteError

The type returned in the event of a conversion error.

fn try_from(byte: u8) -> Result<Self, Utf8ByteError>

Performs the conversion.