Struct SourceText 

pub struct SourceText { /* private fields */ }

A source text and what render_source reads off it every frame: its lines, a hash of each, and its highlight spans.

SourceText::new walks and highlights the whole text. SourceText::edit redoes only the lines an edit touched and shifts the spans around it; the SpanJob it answers highlights the new text in full, on any thread, for SourceText::set_spans. SourceText::rehighlight answers one when the installed highlighter has changed.

Implementations

impl SourceText

pub fn new(code: impl Into<Arc<str>>, cx: &App) -> Self

pub fn text(&self) -> &str

pub fn lines(&self) -> usize

Lines, counting the empty one after a trailing newline.

pub fn line_of(&self, offset: usize) -> usize

The line holding byte offset; past the end, the last line.

pub fn spans(&self) -> Option<&[(Range<usize>, HighlightKind)]>

The highlight spans, in bytes and in order. Between an Self::edit and the Self::set_spans that follows it, the spans from before the edit, shifted past it, and none over the bytes it replaced.

pub fn edit(&mut self, code: &str, cx: &App) -> Option<SpanJob>

Make the text code. The change is taken to be the one run of bytes between the longest prefix and suffix the two texts share. None when the text is unchanged.

pub fn rehighlight(&mut self, cx: &App) -> Option<SpanJob>

Highlight the text again if the installed highlighter has changed since it was last highlighted. The spans stand until the job’s land.

pub fn set_spans(&mut self, spans: Spans) -> bool

Take what a SpanJob found. false, and nothing taken, when the text has been edited or rehighlighted since the job was made.