Struct Buffer

pub struct Buffer { /* private fields */ }

A buffer for text in the line editor.

It keeps track of each action performed on it for use with undo/redo.

Implementations

impl Buffer

pub fn new() -> Self

pub fn clear_actions(&mut self)

pub fn start_undo_group(&mut self)

pub fn end_undo_group(&mut self)

pub fn undo(&mut self) -> Option<usize>

pub fn redo(&mut self) -> Option<usize>

pub fn revert(&mut self) -> bool

pub fn is_last_arg_newline(&self) -> bool

pub fn last_arg(&self) -> Option<&str>

pub fn num_lines(&self) -> usize

pub fn num_graphemes(&self) -> usize

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

pub fn num_bytes(&self) -> usize

pub fn grapheme_before(&self, cursor: usize) -> Option<&str>

pub fn grapheme_after(&self, cursor: usize) -> Option<&str>

pub fn remove_unrecorded(&mut self, start: usize, end: usize)

Returns the graphemes removed. Does not register as an action in the undo/redo buffer or in the buffer’s register.

pub fn remove(&mut self, start: usize, end: usize) -> usize

Returns the number of graphemes removed.

pub fn insert_register_around_idx( &mut self, idx: usize, count: usize, right: bool, ) -> usize

Insert contents of register to the right or to the left of the provided start index in the current buffer and return length of text inserted.

pub fn insert_str(&mut self, start: usize, text: &str) -> usize

pub fn insert<'a, I>(&mut self, start: usize, text: I) -> usize

where I: Iterator<Item = &'a char>,

pub fn insert_action(&mut self, act: Action)

pub fn append_buffer(&mut self, other: &Buffer) -> usize

pub fn copy_buffer(&mut self, other: &Buffer) -> usize

pub fn range_graphemes_all(&self) -> GraphemeIter<'_>

pub fn range_graphemes_until(&self, until: usize) -> GraphemeIter<'_>

pub fn range_graphemes_from(&self, start: usize) -> GraphemeIter<'_>

pub fn range(&self, start: usize, end: usize) -> &str

pub fn range_graphemes(&self, start: usize, end: usize) -> GraphemeIter<'_>

pub fn line_width_until(&self, until: usize) -> impl Iterator<Item = usize> + '_

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

pub fn truncate(&mut self, num: usize)

pub fn print<W>(&self, out: &mut W) -> Result<()>

where W: Write,

pub fn print_rest<W>(&self, out: &mut W, after: usize) -> Result<usize>

where W: Write,

Takes other buffer, measures its length and prints this buffer from the point where the other stopped. Used to implement autosuggestions.

pub fn yank(&mut self, start: usize, end: usize)

pub fn push(&mut self, ch: char)

Push ch onto the end of the buffer.

pub fn starts_with(&self, other: &Buffer) -> bool

Check if the other buffer starts with the same content as this one. Used to implement autosuggestions.

pub fn contains(&self, other: &Buffer) -> bool

Check if the buffer contains pattern. Used to implement history search.

pub fn is_empty(&self) -> bool

Return true if the buffer is empty.

pub fn first(&self) -> Option<&str>

Returns the first grapheme of the buffer or None if empty.

pub fn last(&self) -> Option<&str>

Returns the last grapheme of the buffer or None if empty.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl Display for Buffer

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Buffer

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<Buffer> for String

fn from(buf: Buffer) -> Self

Converts to this type from the input type.

impl From<String> for Buffer

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromIterator<char> for Buffer

fn from_iter<T: IntoIterator<Item = char>>(t: T) -> Self

Creates a value from an iterator.

impl PartialEq for Buffer

fn eq(&self, other: &Self) -> 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 Eq for Buffer