Struct BidiParagraph 

pub struct BidiParagraph { /* private fields */ }

Result of paragraph-level bidi analysis.

Call BidiParagraph::new to analyse a string, then inspect BidiParagraph::runs for the visual-order run sequence.

Implementations

impl BidiParagraph

pub fn new(text: &str, base_rtl: Option<bool>) -> Self

Analyse a paragraph for bidi runs.

The base_rtl argument controls the paragraph base direction:

• None — auto-detect via UAX #9 rules P2/P3 (recommended).
• Some(true) — force RTL base direction.
• Some(false) — force LTR base direction.

The returned runs are in visual order (as they would appear on screen), not logical order.

pub fn runs(&self) -> &[BidiRun]

Returns the resolved visual-order bidi runs.

pub fn base_level(&self) -> u8

Returns the resolved paragraph base embedding level.

pub fn is_rtl(&self) -> bool

Returns true if the paragraph base direction is RTL (odd base level).

pub fn levels(&self) -> &[Level]

Returns the per-byte UAX #9 embedding levels for the source text.

The returned slice is indexed by UTF-8 byte offset. Multi-byte characters have their level repeated for each byte. Use the cluster byte offset from a oxitext_core::ShapedGlyph to look up the level for that glyph.