Struct TextBuffer 

pub struct TextBuffer { /* private fields */ }

A TextDocument held in memory as a line per String.

What a form gets, and what an application with an ordinary amount of text wants. Undo is a journal of the edits, so it costs what was typed rather than a copy of the text per keystroke; consecutive typing on one line is one entry.

Implementations

impl TextBuffer

pub fn new() -> Self

An empty buffer: one empty line.

pub fn from_text(text: &str) -> Self

A buffer holding text.

pub fn text(&self) -> String

The whole text, lines joined by \n.

pub fn lines(&self) -> &[String]

The lines.

Trait Implementations

impl Clone for TextBuffer

fn clone(&self) -> TextBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextBuffer

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

Formats the value using the given formatter.

impl Default for TextBuffer

fn default() -> Self

Returns the “default value” for a type.

impl TextDocument for TextBuffer

fn line_count(&mut self) -> Option<usize>

How many lines there are, or None while that is still being counted.

fn known_lines(&mut self) -> usize

Lines the document can hand over now. Equal to line_count once it is known, and growing until then.

fn line(&mut self, n: usize) -> Option<Cow<'_, str>>

Line n without its newline, or None if it is not (yet) known.

fn insert(&mut self, at: Pos, text: &str)

Inserts text, which may hold newlines, at at.

fn delete(&mut self, from: Pos, to: Pos)

Deletes [from, to). from <= to; a range across lines joins them.

fn undo(&mut self) -> bool

Takes back the last edit. false if there was none.

fn redo(&mut self) -> bool

Redoes the last edit undone. false if there was none.

fn spans(&mut self, n: usize, out: &mut Vec<Span>)

The coloured runs of line n, appended to out in ascending order without overlaps. Text between runs is drawn in the theme’s content colour. The default highlights nothing.

fn highlights(&mut self, n: usize, line: &str, out: &mut Vec<Range<usize>>)

Byte ranges of line n to mark behind the text — every match of a search, say — appended to out in ascending order without overlaps. line is the line’s text as the widget already has it, so marking costs no second read. A range out of order, past the end or not on a character boundary is skipped; the selection is drawn over the marks. The default marks nothing.