Struct shrs_utils::cursor_buffer::CursorBuffer

pub struct CursorBuffer { /* private fields */ }

Friendly wrapper around Rope data structure

Implementations

impl CursorBuffer

pub fn from_text(text: &str) -> Self

Create new CursorBuffer from string and sets cursor location to beginning

pub fn move_cursor(&mut self, loc: Location) -> Result<()>

Move the cursor using a location selector

pub fn move_cursor_clamp(&mut self, _loc: Location)

Move the cursor using a location selector, clamping the cursor if it were to move to invalid position

pub fn insert(&mut self, loc: Location, text: &str) -> Result<()>

Insert text and advance cursor to after the text inserted

pub fn insert_inplace(&mut self, loc: Location, text: &str) -> Result<()>

Insert text and offset cursor to point to same text

pub fn delete(&mut self, start: Location, end: Location) -> Result<()>

Delete a length of text starting from location and move cursor to start of deleted text

pub fn location_slice( &mut self, start: Location, end: Location ) -> Result<RopeSlice<'_>>

pub fn delete_inplace(&mut self, _loc: Location, _len: usize) -> Result<()>

Delete a length of text starting from location and offset the cursor accordingly such that it points to the same text

In the case that cursor was pointing at deleted text, the behavior is the same as delete

pub fn delete_before(&mut self, start: Location, end: Location) -> Result<()>

Delete a length of text ending at location

pub fn clear(&mut self)

Empties all text and resets cursor

pub fn slice<R>(&self, char_range: R) -> RopeSlice<'_>

where R: RangeBounds<usize>,

Get a slice of the text

pub fn chars(&self, loc: Location) -> Result<Chars<'_>>

Create forward iterator of chars from a location

pub fn cursor(&self) -> usize

Getter for the current index of the cursor

pub fn len(&self) -> usize

Get the length of the text in number of characters

pub fn is_empty(&self) -> bool

Check whether the buffer is empty

pub fn char_at(&self, loc: Location) -> Option<char>

Get char at position

pub fn rope(&self) -> &Rope

Get reference to underlying rope structure

pub fn to_absolute(&self, loc: Location) -> Result<usize>

Converts Location to an absolute index into the buffer. Performs bounds checking

pub fn as_str(&self) -> Cow<'_, str>

Get borrowed contents of CursorBuffer as a string

Trait Implementations

impl Default for CursorBuffer

fn default() -> Self

Returns the “default value” for a type.