Struct unicode_bidi::BidiInfo
source · [−]pub struct BidiInfo<'text> {
pub text: &'text str,
pub original_classes: Vec<BidiClass>,
pub levels: Vec<Level>,
pub paragraphs: Vec<ParagraphInfo>,
}
Expand description
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
sourceimpl<'text> BidiInfo<'text>
impl<'text> BidiInfo<'text>
sourcepub fn new(text: &str, default_para_level: Option<Level>) -> BidiInfo<'_>
pub fn new(text: &str, default_para_level: Option<Level>) -> BidiInfo<'_>
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
sourcepub fn reordered_levels(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>
pub fn reordered_levels(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>
Re-order a line based on resolved levels and return only the embedding levels, one Level
per byte.
sourcepub fn reordered_levels_per_char(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>
pub fn reordered_levels_per_char(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Vec<Level>
Re-order a line based on resolved levels and return only the embedding levels, one Level
per character.
sourcepub fn reorder_line(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Cow<'text, str>
pub fn reorder_line(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> Cow<'text, str>
Re-order a line based on resolved levels and return the line in display order.
sourcepub fn visual_runs(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> (Vec<Level>, Vec<LevelRun>)
pub fn visual_runs(
&self,
para: &ParagraphInfo,
line: Range<usize>
) -> (Vec<Level>, Vec<LevelRun>)
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
Trait Implementations
impl<'text> StructuralPartialEq for BidiInfo<'text>
Auto Trait Implementations
impl<'text> RefUnwindSafe for BidiInfo<'text>
impl<'text> Send for BidiInfo<'text>
impl<'text> Sync for BidiInfo<'text>
impl<'text> Unpin for BidiInfo<'text>
impl<'text> UnwindSafe for BidiInfo<'text>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more