Struct TextBuffer 

pub struct TextBuffer { /* private fields */ }

One line of text and a caret, for a text field.

The caret is a character index and moves by grapheme cluster, so an accent is never split from its letter. The operations are the ones a shell line has (and Input binds): insert, Backspace, Delete, Ctrl+U (delete to the start), Ctrl+W (delete a word), and moving by grapheme or to the ends. checkpoint keeps an undo point and undo goes back to the last one.

Implementations

impl TextBuffer

pub fn new() -> TextBuffer

pub fn with_text(text: impl Into<String>) -> TextBuffer

A buffer holding text, the caret at its end.

pub fn text(&self) -> &str

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

The length in characters.

pub fn set_text(&mut self, text: impl Into<String>)

Replace the text, the caret at its end.

pub fn caret(&self) -> usize

The caret, in characters.

pub fn set_caret(&mut self, caret: usize)

Put the caret at character caret (clamped to the end), or at the start of the grapheme caret falls inside.

pub fn byte(&self, caret: usize) -> usize

The byte offset of character caret.

pub fn before_caret(&self) -> &str

The text before the caret.

pub fn stops(&self) -> Vec<usize>

The character indices where graphemes start, and the end: where the caret may stop.

pub fn previous_stop(&self) -> usize

The caret one grapheme back.

pub fn next_stop(&self) -> usize

The caret one grapheme on.

pub fn insert(&mut self, text: &str)

Insert text at the caret, and move past it.

pub fn left(&mut self)

Move the caret one grapheme left.

pub fn right(&mut self)

Move the caret one grapheme right.

pub fn home(&mut self)

pub fn end(&mut self)

pub fn backspace(&mut self) -> bool

Delete the grapheme before the caret; false at the start.

pub fn delete(&mut self) -> bool

Delete the grapheme after the caret; false at the end.

pub fn delete_to_start(&mut self)

Delete everything before the caret (Ctrl+U).

pub fn delete_word(&mut self)

Delete the word before the caret, and the spaces after it (Ctrl+W).

pub fn checkpoint(&mut self)

Keep the text and caret as an undo point.

pub fn undo(&mut self) -> bool

Go back to the last undo point; false when there is none.

pub fn masked(text: &str, mask: Option<char>) -> String

text as shown: every character as mask when there is one.

pub fn window(&self, available: usize, mask: Option<char>) -> (String, usize)

The text as shown (masked or not), cut to available cells so the caret stays in view: a line longer than the space scrolls. Returns what to show and the caret’s column in it.

Trait Implementations

impl Clone for TextBuffer

fn clone(&self) -> Self

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 Eq for TextBuffer

impl PartialEq for TextBuffer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextBuffer