Struct wezterm_bidi::BidiRun

pub struct BidiRun {
    pub direction: Direction,
    pub level: Level,
    pub range: Range<usize>,
    pub removed_by_x9: Vec<usize>,
}

A BidiRun represents a run which is a contiguous sequence of codepoints from the original paragraph that have been resolved to the same embedding level, and that thus all have the same direction.

The range field encapsulates the starting and ending codepoint indices into the original paragraph.

Note: while the run sequence has the same level throughout, the X9 portion of the bidi algorithm can logically delete some control characters. I haven’t been able to prove to myself that those control characters never manifest in the middle of a run, so it is recommended that you use the indices method to skip over any such elements if your shaper doesn’t want them.

Fields

direction: Direction

The direction for this run. Derived from the level.

level: Level

Embedding level of this run.

range: Range<usize>

The starting and ending codepoint indices for this run

removed_by_x9: Vec<usize>

the list of control codepoint indices that were removed from the text by the X9 portion of the bidi algorithm.

Implementations

impl BidiRun

pub fn indices<'a>(&'a self) -> impl Iterator<Item = usize> + 'a

Trait Implementations

impl Clone for BidiRun

fn clone(&self) -> BidiRun

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BidiRun

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BidiRun

fn eq(&self, other: &BidiRun) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BidiRun

impl StructuralEq for BidiRun

impl StructuralPartialEq for BidiRun