Struct Buffer

pub struct Buffer { /* private fields */ }

A Gap buffer. This represents the text of a buffer, and allows for efficient insertion and deletion of text.

Implementations

impl Buffer

pub fn new() -> Self

Create a new empty text buffer with the default gap size.

pub fn with_gap(gap: usize) -> Self

Create a new empty text buffer with the specified gap size.

pub fn insert_char(&mut self, chr: char)

Insert a character into the buffer at the cursor.

pub fn insert(&mut self, slice: &str)

Insert the text into the buffer at the cursor.

pub fn delete_backwards(&mut self, size: usize)

Delete backwards from the cursor size characters.

pub fn delete_forwards(&mut self, size: usize)

Delete forwards from the cursor size characters.

pub fn delete_range(&mut self, beg: usize, end: usize)

Delete all text between the two character positions.

pub fn cursor(&self) -> Position

Get the cursor position.

pub fn char_at(&self, pos: usize) -> Option<char>

Get the character at pos.

pub fn move_gap_out_of(&mut self, range: impl RangeBounds<usize>)

Move the gap out of range. This is useful when you need to access the data in a contiguous manner.

pub fn set_cursor(&mut self, pos: usize)

Set the cursor to the pos character.

pub fn len_bytes(&self) -> usize

Get the length of the buffer in bytes.

pub const fn len_chars(&self) -> usize

Get the length of the buffer in characters.

pub const fn is_empty(&self) -> bool

Return true if the buffer is empty.

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

Covert the character position to a byte position.

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

Convert the byte position to a character position.

pub fn slice(&self, bounds: impl RangeBounds<usize>) -> (&str, &str)

Get a slice from the buffer with the given character bounds. If the slice is split across the gap, the two halves are returned separately. If a contiguous slice is needed, call ](crate::Buffer::slice_[move_gap_out_of`](crate::Buffer::move_gap_out_of) first.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Buffer

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 From<&str> for Buffer

fn from(data: &str) -> Self

Converts to this type from the input type.

impl From<String> for Buffer

fn from(data: String) -> Self

Converts to this type from the input type.

impl GetSize for Buffer

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl<T> PartialEq<T> for Buffer

where T: Deref<Target = str>,

fn eq(&self, other: &T) -> 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 PartialEq<str> for Buffer

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