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

# Struct unicode_bidi::BidiInfo [−] [src]

    pub struct BidiInfo<'text> {
        pub text: &'text str,
        pub original_classes: Vec<BidiClass>,
        pub levels: Vec<Level>,
        pub paragraphs: Vec<ParagraphInfo>,
    }

Bidi information of the text.

The `original_classes` and `levels` vectors are indexed by byte offsets into the text. If a character is multiple bytes wide, then its class and level will appear multiple times in these vectors.

## Fields

`text: &'text str`

The text

`original_classes: Vec<BidiClass>`

The BidiClass of the character at each byte in the text.

`levels: Vec<Level>`

The directional embedding level of each byte in the text.

`paragraphs: Vec<ParagraphInfo>`

The boundaries and paragraph embedding level of each paragraph within the text.

TODO: Use SmallVec or similar to avoid overhead when there are only one or two paragraphs? Or just don't include the first paragraph, which always starts at 0?

## Implementations

### `impl<'text> BidiInfo<'text>` [src]

#### `pub fn new(text: &str, default_para_level: Option<Level>) -> BidiInfo<'_>` [src]

Split the text into paragraphs and determine the bidi embedding levels for each paragraph.

TODO: In early steps, check for special cases that allow later steps to be skipped. like text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.

TODO: Support auto-RTL base direction

#### `pub fn reordered_levels(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>` [src]

Re-order a line based on resolved levels and return only the embedding levels, one `Level` per byte.

#### `pub fn reordered_levels_per_char(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>` [src]

Re-order a line based on resolved levels and return only the embedding levels, one `Level` per character.

#### `pub fn reorder_line(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Cow<'text, str>` [src]

Re-order a line based on resolved levels and return the line in display order.

#### `pub fn visual_runs(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> (Vec<Level>, Vec<LevelRun>)` [src]

Find the level runs within a line and return them in visual order.

`line` is a range of bytes indices within `levels`.

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

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

If processed text has any computed RTL levels

This information is usually used to skip re-ordering of text when no RTL level is present

## Trait Implementations

### `impl<'text> Debug for BidiInfo<'text>` [src]

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

Formats the value using the given formatter. Read more

### `impl<'text> PartialEq<BidiInfo<'text>> for BidiInfo<'text>` [src]

#### `fn eq(&self, other: &BidiInfo<'text>) -> bool` [src]

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

#### `fn ne(&self, other: &BidiInfo<'text>) -> bool` [src]

This method tests for `!=`.

### `impl<'text> StructuralPartialEq for BidiInfo<'text>` [src]

## Auto Trait Implementations

### `impl<'text> RefUnwindSafe for BidiInfo<'text>` [src]

### `impl<'text> Send for BidiInfo<'text>` [src]

### `impl<'text> Sync for BidiInfo<'text>` [src]

### `impl<'text> Unpin for BidiInfo<'text>` [src]

### `impl<'text> UnwindSafe for BidiInfo<'text>` [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, 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.