Struct ScreenLines

pub struct ScreenLines {
    pub lines: Rc<Vec<RVLine>>,
    pub info: Rc<HashMap<RVLine, LineInfo>>,
    pub diff_sections: Option<Rc<Vec<DiffSection>>>,
    pub base: RwSignal<ScreenLinesBase>,
}

Fields

lines: Rc<Vec<RVLine>>

info: Rc<HashMap<RVLine, LineInfo>>

Guaranteed to have an entry for each VLine in lines
You should likely use accessor functions rather than this directly.

diff_sections: Option<Rc<Vec<DiffSection>>>

base: RwSignal<ScreenLinesBase>

The base y position that all the y positions inside info are relative to.
This exists so that if a text layout is created outside of the view, we don’t have to completely recompute the screen lines (or do somewhat intricate things to update them) we simply have to update the base_y.

Implementations

impl ScreenLines

pub fn new(cx: Scope, viewport: Rect) -> ScreenLines

pub fn is_empty(&self) -> bool

pub fn clear(&mut self, viewport: Rect)

pub fn info(&self, rvline: RVLine) -> Option<LineInfo>

Get the line info for the given rvline.

pub fn vline_info(&self, rvline: RVLine) -> Option<VLineInfo<()>>

pub fn rvline_range(&self) -> Option<(RVLine, RVLine)>

pub fn iter_line_info(&self) -> impl Iterator<Item = LineInfo> + '_

Iterate over the line info, copying them with the full y positions.

pub fn iter_line_info_r( &self, r: RangeInclusive<RVLine>, ) -> impl Iterator<Item = LineInfo> + '_

Iterate over the line info within the range, copying them with the full y positions.
If the values are out of range, it is clamped to the valid lines within.

pub fn iter_vline_info(&self) -> impl Iterator<Item = VLineInfo<()>> + '_

pub fn iter_vline_info_r( &self, r: RangeInclusive<RVLine>, ) -> impl Iterator<Item = VLineInfo<()>> + '_

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

Iter the real lines underlying the visual lines on the screen

pub fn iter_lines_y(&self) -> impl Iterator<Item = (usize, f64)> + '_

Iterate over the real lines underlying the visual lines on the screen with the y position of their layout.
(line, y)

pub fn info_for_line(&self, line: usize) -> Option<LineInfo>

Get the earliest line info for a given line.

pub fn first_rvline_for_line(&self, line: usize) -> Option<RVLine>

Get the earliest rvline for the given line

pub fn last_rvline_for_line(&self, line: usize) -> Option<RVLine>

Get the latest rvline for the given line

pub fn on_created_layout(&self, ed: &Editor, line: usize) -> bool

Ran on LayoutEvent::CreatedLayout to update ScreenLinesBase & the viewport if necessary.

Returns true if ScreenLines needs to be completely updated in response

Trait Implementations

impl Clone for ScreenLines

fn clone(&self) -> ScreenLines

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for ScreenLines

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ScreenLines