Struct BidiLevel 

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

Bidirectional text embedding level.

These are numbers indicating how deeply bidirectional embeddings are nested in the text, and the default direction of text on that level. Even levels are left-to-right, odd levels are right-to-left. Normally, the minimum level is 0 (left-to-right), and the maximum level, according to UAX #9 § 3.1.1 BD2, is 125.

See UAX #9 § 3.1 for more information.

Implementations

impl BidiLevel

pub const MAX: Self

The maximum bidirectional text embedding level, according to UAX #9 § 3.1.1 BD2.

It is possible for BidiLevel to encode greater values; in particular, unsafe code must not rely on BidiLevel never being greater than this.

pub const fn new(level: u8) -> Self

Construct a new bidi level.

pub const fn to_u8(self) -> u8

Get the numeric bidi level.

pub const fn is_ltr(self) -> bool

Whether this level is left-to-right.

pub const fn is_rtl(self) -> bool

Whether this level is right-to-left.

pub const fn next_odd(self) -> Self

Get the next odd bidi level.

When the return value overflows (self.to_u8() >= 255) this panics when overflow checks are enabled. Otherwise, the return value wraps.

pub const fn next_even(self) -> Self

Get the next even bidi level.

When the return value overflows (self.to_u8() >= 254) this panics when overflow checks are enabled. Otherwise, the return value wraps.

Trait Implementations

impl Clone for BidiLevel

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 BidiLevel

impl Debug for BidiLevel

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

Formats the value using the given formatter.

impl Default for BidiLevel

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BidiLevel

impl Hash for BidiLevel

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 BidiLevel

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 BidiLevel

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BidiLevel

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 Pod for BidiLevel

Available on crate feature bytemuck only.

impl StructuralPartialEq for BidiLevel

impl Zeroable for BidiLevel

Available on crate feature bytemuck only.

fn zeroed() -> Self

Calls zeroed.