Struct 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<'_>>

Iterate over the lines of the buffer

pub fn len_lines(&self) -> usize

The number of lines within the buffer

pub fn len_chars(&self) -> usize

The number of characters in the buffer

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

pub fn clear(&mut self)

Clear the contents of the buffer.

Note

This does not actually zero out the data currently within the buffer or truncate the allocation in any way. It simply resets internal state so that it behaves like an empty initial buffer.

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

The character at the specified character index.

Panics

This method will panic if the given character index is out of bounds

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

The character at the specified character index.

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

The requested line as a Slice.

Panics

This method will panic if the given line index is out of bounds

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

The number of characters in the requested line.

Panics

This method will panic if the given line index is out of bounds

pub fn maximal_slice_from_offset(&self, byte_offset: usize) -> &[u8]

Primarily intended for supplying contiguous ranges of bytes to tree-sitter when parsing. Returns a byte slice from the underlying data buffer without entering the gap.

pub fn slice_from_byte_offsets( &self, byte_from: usize, byte_to: usize, ) -> Slice<'_>

An exclusive range of characters from the buffer

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

An exclusive range of characters from the buffer

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

Convert a byte index to a character index

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

Convert a character index to the index of the line containing it

Panics

This method will panic if the given char index is out of bounds

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

Convert a character index to the index of the line containing it

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

Convert a line index to the character index of its first character

Panics

This method will panic if the given char index is out of bounds

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

Convert a line index to the character index of its first character

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.

Panics

This method will panic if char_from < char_to

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

Convert a character offset within the logical buffer to a byte offset within the logical buffer. This is used to account for multi-byte characters within the buffer and is treated as a String-like index but it does not account for the position of the gap.

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

Trait Implementations

impl Clone for GapBuffer

fn clone(&self) -> GapBuffer

Returns a duplicate 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 insert(&mut self, idx: usize, s: &str)

Insert a string at the specified index

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

Remove all characters from (from..to)

fn submatch(&self, m: &Match, n: usize) -> Option<String>

Extract the content of a previous submatch so it can be used in templating

fn begin_edit_transaction(&mut self)

Mark the start of an edit transaction

fn end_edit_transaction(&mut self)

Mark the end of an edit transaction

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 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<'a> TextProvider<&'a [u8]> for &'a GapBuffer

type I = SliceIter<'a>

fn text(&mut self, node: Node<'_>) -> Self::I

impl Eq for GapBuffer

impl StructuralPartialEq for GapBuffer