Crate unicode_bidi

Expand description

This crate implements the Unicode Bidirectional Algorithm for display of mixed right-to-left and left-to-right text. It is written in safe Rust, compatible with the current stable release.

§Example

use unicode_bidi::BidiInfo;

// This example text is defined using `concat!` because some browsers
// and text editors have trouble displaying bidi strings.
let text = concat![
  "א",
  "ב",
  "ג",
  "a",
  "b",
  "c",
];

// Resolve embedding levels within the text.  Pass `None` to detect the
// paragraph level automatically.
let bidi_info = BidiInfo::new(&text, None);

// This paragraph has embedding level 1 because its first strong character is RTL.
assert_eq!(bidi_info.paragraphs.len(), 1);
let para = &bidi_info.paragraphs[0];
assert_eq!(para.level.number(), 1);
assert_eq!(para.level.is_rtl(), true);

// Re-ordering is done after wrapping each paragraph into a sequence of
// lines. For this example, I'll just use a single line that spans the
// entire paragraph.
let line = para.range.clone();

let display = bidi_info.reorder_line(para, line);
assert_eq!(display, concat![
  "a",
  "b",
  "c",
  "ג",
  "ב",
  "א",
]);

§Features

std: Enabled by default, but can be disabled to make unicode_bidi #![no_std] + alloc compatible.
hardcoded-data: Enabled by default. Includes hardcoded Unicode bidi data and more convenient APIs.
serde: Adds [serde::Serialize] and [serde::Deserialize] implementations to relevant types.

Re-exports§

pub use crate::data_source::BidiDataSource;
pub use crate::level::Level;
pub use crate::level::LTR_LEVEL;
pub use crate::level::RTL_LEVEL;

Modules§

char_data 🔒: Accessor for Bidi_Class property from Unicode Character Database (UCD)
data_source
deprecated: This module holds deprecated assets only.
explicit 🔒: 3.3.2 Explicit Levels and Directions
format_chars: Directional Formatting Characters
implicit 🔒: 3.3.4 - 3.3.6. Resolve implicit levels and types.
level: Bidi Embedding Level
prepare 🔒: 3.3.3 Preparations for Implicit Processing
private 🔒
utf16

Structs§

BidiInfo: Bidi information of the text.
HardcodedBidiData: Hardcoded Bidi data that ships with the unicode-bidi crate.
InitialInfo: Initial bidi information of the text.
InitialInfoExt 🔒: Extended version of InitialInfo (not public API).
Paragraph: Contains a reference of BidiInfo and one of its paragraphs. And it supports all operation in the Paragraph that needs also its BidiInfo such as direction.
ParagraphBidiInfo: Bidi information of text treated as a single paragraph.
ParagraphInfo: Bidi information about a single paragraph
ParagraphInfoFlags 🔒
Utf8IndexLenIter: Iterator over (UTF-8) string slices returning (index, char_len) tuple.

Enums§

BidiClass: Represents values of the Unicode character property Bidi_Class, also known as the bidirectional character type.
Direction

Constants§

UNICODE_VERSION: The Unicode version of data

Traits§

TextSource: Trait that abstracts over a text source for use by the bidi algorithms. We implement this for str (UTF-8) and for u16 (UTF-16, native-endian). (For internal unicode-bidi use; API may be unstable.) This trait is sealed and cannot be implemented for types outside this crate.

Functions§

assign_levels_to_removed_chars 🔒: Assign levels to characters removed by rule X9.
bidi_class: Find the BidiClass of a single char.
compute_bidi_info_for_para 🔒: The core of BidiInfo initialization, factored out into a function that both the utf-8 and utf-16 versions of BidiInfo can use.
compute_initial_info 🔒: Implementation of initial-info computation for both BidiInfo and ParagraphBidiInfo. To treat the text as (potentially) multiple paragraphs, the caller should pass the pair of optional outparam arrays to receive the ParagraphInfo and pure-ltr flags for each paragraph. Passing None for split_paragraphs will ignore any paragraph- separator characters in the text, treating it just as a single paragraph. Returns the array of BidiClass values for each code unit of the text, along with the embedding level and pure-ltr flag for the last (or only) paragraph.
get_base_direction: Get the base direction of the text provided according to the Unicode Bidirectional Algorithm.
get_base_direction_full: Get the base direction of the text provided according to the Unicode Bidirectional Algorithm, considering the full text if the first paragraph is all-neutral.
get_base_direction_full_with_data_source
get_base_direction_impl 🔒
get_base_direction_with_data_source
para_direction 🔒: Return the directionality of the paragraph (Left, Right or Mixed) from its levels.
reorder_levels 🔒: Produce the levels for this paragraph as needed for reordering, one level per code unit in the paragraph. The returned vector includes code units that are not included in the line, but will not adjust them.
reorder_line 🔒: Return a line of the text in display order based on resolved levels.
reorder_visual 🔒: Reorders pre-calculated levels of a sequence of characters.
visual_runs_for_line 🔒: Find the level runs within a line and return them in visual order.

Type Aliases§

LevelRun: A maximal substring of characters with the same embedding level.
LevelRunVec

Crate unicode_bidiCopy item path