# unicode_bidi::level::Level - Rust
API documentation for the Rust `Level` struct in crate `unicode_bidi`.
Keywords: rust, rustlang, rust-lang, Level

# Struct unicode_bidi::level::Level [−] [src]

    pub struct Level(_);

Embedding Level

Embedding Levels are numbers between 0 and 126 (inclusive), where even values denote a left-to-right (LTR) direction and odd values a right-to-left (RTL) direction.

This struct maintains a valid status for level numbers, meaning that creating a new level, or mutating an existing level, with the value smaller than `0` (before conversion to `u8`) or larger than 125 results in an `Error`.

http://www.unicode.org/reports/tr9/#BD2

## Implementations

### `impl Level` [src]

#### `pub fn ltr() -> Level` [src]

New LTR level with smallest number value (0).

#### `pub fn rtl() -> Level` [src]

New RTL level with smallest number value (1).

#### `pub fn max_implicit_depth() -> u8` [src]

Maximum depth of the directional status stack during implicit resolutions.

#### `pub fn max_explicit_depth() -> u8` [src]

Maximum depth of the directional status stack during explicit resolutions.

#### `pub fn new(number: u8) -> Result<Level, Error>` [src]

Create new level, fail if number is larger than `max_depth + 1`.

#### `pub fn new_explicit(number: u8) -> Result<Level, Error>` [src]

Create new level, fail if number is larger than `max_depth`.

#### `pub fn number(&self) -> u8` [src]

The level number.

#### `pub fn is_ltr(&self) -> bool` [src]

If this level is left-to-right.

#### `pub fn is_rtl(&self) -> bool` [src]

If this level is right-to-left.

#### `pub fn raise(&mut self, amount: u8) -> Result<(), Error>` [src]

Raise level by `amount`, fail if number is larger than `max_depth + 1`.

#### `pub fn raise_explicit(&mut self, amount: u8) -> Result<(), Error>` [src]

Raise level by `amount`, fail if number is larger than `max_depth`.

#### `pub fn lower(&mut self, amount: u8) -> Result<(), Error>` [src]

Lower level by `amount`, fail if number goes below zero.

#### `pub fn new_explicit_next_ltr(&self) -> Result<Level, Error>` [src]

The next LTR (even) level greater than this, or fail if number is larger than `max_depth`.

#### `pub fn new_explicit_next_rtl(&self) -> Result<Level, Error>` [src]

The next RTL (odd) level greater than this, or fail if number is larger than `max_depth`.

#### `pub fn new_lowest_ge_rtl(&self) -> Result<Level, Error>` [src]

The lowest RTL (odd) level greater than or equal to this, or fail if number is larger than `max_depth + 1`.

#### `pub fn bidi_class(&self) -> BidiClass` [src]

Generate a character type based on a level (as specified in steps X10 and N2).

#### `pub fn vec(v: &[u8]) -> Vec<Level>` [src]

## Trait Implementations

### `impl Clone for Level` [src]

#### `fn clone(&self) -> Level` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Copy for Level` [src]

### `impl Debug for Level` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Eq for Level` [src]

### `impl From<u8> for Level` [src]

#### `fn from(number: u8) -> Level` [src]

Create level by number

### `impl Into<u8> for Level` [src]

#### `fn into(self) -> u8` [src]

Convert to the level number

### `impl Ord for Level` [src]

#### `fn cmp(&self, other: &Level) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0 [src]

Restrict a value to a certain interval. Read more

### `impl<'a> PartialEq<&'a str> for Level` [src]

Used for matching levels in conformance tests

#### `fn eq(&self, s: &&'a str) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl PartialEq<Level> for Level` [src]

#### `fn eq(&self, other: &Level) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Level) -> bool` [src]

This method tests for `!=`.

### `impl<'a> PartialEq<String> for Level` [src]

Used for matching levels in conformance tests

#### `fn eq(&self, s: &String) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl PartialOrd<Level> for Level` [src]

#### `fn partial_cmp(&self, other: &Level) -> Option<Ordering>` [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Level) -> bool` [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Level) -> bool` [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Level) -> bool` [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Level) -> bool` [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl StructuralEq for Level` [src]

### `impl StructuralPartialEq for Level` [src]

## Auto Trait Implementations

### `impl RefUnwindSafe for Level` [src]

### `impl Send for Level` [src]

### `impl Sync for Level` [src]

### `impl Unpin for Level` [src]

### `impl UnwindSafe for Level` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.