Struct GapBuffer 

pub struct GapBuffer { /* private fields */ }

A gap buffer structure.

Useful for small and frequent insertions and deletions. O(1) insertions and deletions on average. O(n) gap repositioning on edit location change.

Example use case: Shell

Trait Implementations

impl TextBuffer for GapBuffer

fn create_buffer(init_size: usize) -> Self

where Self: Sized,

Creates a gap buffer according to gap size.

Start is at first insertable location. End is at first character after last insertable location.

Buffer is initialized to designated gap size.

fn insert(&mut self, pos: usize, char: char)

Inserts into a gap buffer.

1. Moves gap
2. Checks if gap is empty (if so, resize by doubling existing buffer length)
3. Insert at gap_start and increment gap_start by 1 (slot filled)

Panics

Panics if pos is out of bounds.

fn delete(&mut self, start: usize, len: usize)

Deletes from a gap buffer.

1. Moves gap
2. Extends gap by len by adding to gap_end

Panics

Panics if gap_end + len is out of bounds.

fn read( &self, start: usize, end: usize, ) -> impl DoubleEndedIterator<Item = &char>

Reads from a gap buffer.

Reads from the left and right of the buffer, skipping over the gap.

Panics

Panics if start is out of bounds. Panics if end is out of bounds. Panics if start is greater than end.

fn len(&self) -> usize

Calculates the length of a gap buffer.

Length = Length of buffer - size of gap