Struct ad_editor::buffer::GapBuffer

pub struct GapBuffer { /* private fields */ }

An implementation of a gap buffer that tracks internal meta-data to help with accessing sub-regions of the text such as character ranges and lines.

Implementations

impl GapBuffer

pub fn len(&self) -> usize

The current length of “active” data in the buffer (i.e. not including the gap)

pub fn is_empty(&self) -> bool

Whether or not the visible buffer contents are empty or not. This can return true while there is “deleted” data in the gap.

pub fn bytes(&self) -> Vec<u8>

The raw content of the buffer

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

pub fn len_lines(&self) -> usize

pub fn len_chars(&self) -> usize

pub fn clear(&mut self)

pub fn char(&self, char_idx: usize) -> char

pub fn get_char(&self, char_idx: usize) -> Option<char>

pub fn line(&self, line_idx: usize) -> Slice<'_>

pub fn line_len_chars(&self, line_idx: usize) -> usize

pub fn slice(&self, char_from: usize, char_to: usize) -> Slice<'_>

An exclusive range of characters from the buffer

pub fn byte_to_char(&self, byte_idx: usize) -> usize

pub fn char_to_line(&self, char_idx: usize) -> usize

pub fn try_char_to_line(&self, char_idx: usize) -> Option<usize>

pub fn line_to_char(&self, line_idx: usize) -> usize

pub fn try_line_to_char(&self, line_idx: usize) -> Option<usize>

pub fn insert_char(&mut self, char_idx: usize, ch: char)

Insert a single character at the specifified byte index.

This is O(1) if idx is at the current gap start and the gap is large enough to accomodate the new text, otherwise data will need to be copied in order to relocate the gap.

pub fn insert_str(&mut self, char_idx: usize, s: &str)

Insert a string at the specifified byte index.

This is O(1) if idx is at the current gap start and the gap is large enough to accomodate the new text, otherwise data will need to be copied in order to relocate the gap.

pub fn remove_char(&mut self, char_idx: usize)

Remove the requested character index from the visible region of the buffer

pub fn remove_range(&mut self, char_from: usize, char_to: usize)

Remove the requested range (from..to) from the visible region of the buffer

Trait Implementations

impl Address for GapBuffer

fn current_dot(&self) -> Dot

This only really makes sense for use with a buffer but is supported so that don’t need to special case running programs against an in-editor buffer vs stdin or a file read from disk.

fn len_chars(&self) -> usize

fn line_to_char(&self, line_idx: usize) -> Option<usize>

fn char_to_line(&self, char_idx: usize) -> Option<usize>

fn char_to_line_end(&self, char_idx: usize) -> Option<usize>

fn char_to_line_start(&self, char_idx: usize) -> Option<usize>

fn max_iter(&self) -> usize

fn map_addr(&self, a: &mut Addr) -> Dot

fn full_line(&self, line_idx: usize) -> Option<Dot>

fn map_simple_addr(&self, addr: &mut SimpleAddr, cur_dot: Dot) -> Option<Dot>

fn map_compound_addr( &self, from: &mut SimpleAddr, to: &mut SimpleAddr, ) -> Option<Dot>

impl Clone for GapBuffer

fn clone(&self) -> GapBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GapBuffer

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

Formats the value using the given formatter.

impl Default for GapBuffer

fn default() -> GapBuffer

Returns the “default value” for a type.

impl Display for GapBuffer

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

Formats the value using the given formatter.

impl Edit for GapBuffer

fn contents(&self) -> String

fn insert(&mut self, idx: usize, s: &str)

fn remove(&mut self, from: usize, to: usize)

fn begin_edit_transaction(&mut self)

fn end_edit_transaction(&mut self)

impl From<&str> for GapBuffer

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for GapBuffer

fn from(s: String) -> Self

Converts to this type from the input type.

impl IterBoundedChars for GapBuffer

fn iter_between(&self, from: usize, to: usize) -> CharIter<'_>

Iterate forward: from -> to

fn rev_iter_between(&self, from: usize, to: usize) -> CharIter<'_>

Iterate backward: from -> to

impl PartialEq for GapBuffer

fn eq(&self, other: &GapBuffer) -> 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 GapBuffer

impl StructuralPartialEq for GapBuffer