Struct TextBuffer

pub struct TextBuffer { /* private fields */ }

A text buffer where characters are manipulated visually with consideration on the unicode width of characters. Characters can span more than 1 cell, therefore visually manipulating text in a 2-dimensional way should consider using the unicode width.

Implementations

impl TextBuffer

pub fn new_from_str(content: &str) -> Self

pub fn from_ch(chars: &[&[Ch]]) -> Self

pub fn is_empty(&self) -> bool

pub fn chars(&self) -> &[Vec<Ch>]

pub fn total_chars(&self) -> usize

return the total number of characters excluding new lines

pub fn split_line_at_point(&self, loc: Point2<usize>) -> (String, String)

pub fn split_line_at_2_points( &self, loc: Point2<usize>, loc2: Point2<usize>, ) -> (String, String, String)

pub fn cut_text_in_linear_mode( &mut self, start: Point2<usize>, end: Point2<usize>, ) -> String

Remove the text within the start and end position then return the deleted text

pub fn get_text_in_linear_mode( &self, start: Point2<usize>, end: Point2<usize>, ) -> String

get the text in between start and end if selected in linear mode

pub fn get_text_in_block_mode( &self, start: Point2<usize>, end: Point2<usize>, ) -> String

get the text in between start and end if selected in block mode

pub fn cut_text_in_block_mode( &mut self, start: Point2<usize>, end: Point2<usize>, ) -> String

pub fn paste_text_in_block_mode(&mut self, text_block: String)

paste the text block in the cursor location

impl TextBuffer

text manipulation This are purely manipulating text into the text buffer. The cursor shouldn’t be move here, since it is done by the commands functions

pub fn total_lines(&self) -> usize

the total number of lines of this text canvas

pub fn numberline_wide(&self) -> usize

return the number of characters to represent the line number of the last line of this text buffer

pub fn lines(&self) -> Vec<String>

pub fn first_non_blank_line(&self) -> Option<usize>

return the first non blank line

pub fn last_non_blank_line(&self) -> Option<usize>

return the last non blank line

pub fn line_width(&self, n: usize) -> usize

the width of the line at line n

pub fn max_column_width(&self) -> usize

get the length of the widest line

pub fn max_position(&self) -> Point2<usize>

return rectangular position starting from 0,0 to contain all the text

pub fn last_char_position(&self) -> Point2<usize>

pub fn break_line(&mut self, loc: Point2<usize>)

break at line y and put the characters after x on the next line

pub fn join_line(&mut self, loc: Point2<usize>)

pub fn ensure_line_exist(&mut self, y: usize)

ensure line at index y exist

pub fn ensure_before_line_exist(&mut self, y: usize)

pub fn ensure_cell_exist(&mut self, loc: Point2<usize>)

ensure line in index y exist and the cell at index x

pub fn ensure_before_cell_exist(&mut self, loc: Point2<usize>)

pub fn insert_char(&mut self, loc: Point2<usize>, ch: char)

insert a character at this x and y and move cells after it to the right

pub fn insert_text(&mut self, loc: Point2<usize>, text: &str)

pub fn replace_char(&mut self, loc: Point2<usize>, ch: char) -> Option<char>

replace the character at this location

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

get the character at this cursor position

pub fn delete_char(&mut self, loc: Point2<usize>) -> Option<char>

delete character at this position

pub fn get_position(&self) -> Point2<usize>

return the position of the cursor

impl TextBuffer

Command implementation here

functions that are preceeded with command also moves the cursor and highlight the texts

Note: methods that are preceeded with command such as command_insert_char are high level methods which has consequences in the text buffer such as moving the cursor. While there corresponding more primitive counter parts such as insert_char are low level commands, which doesn’t move the cursor location

pub fn command_insert_char(&mut self, ch: char)

pub fn command_replace_char(&mut self, ch: char) -> Option<char>

pub fn command_insert_text(&mut self, text: &str)

pub fn move_left(&mut self)

pub fn move_left_start(&mut self)

pub fn move_right(&mut self)

pub fn move_right_clamped(&mut self)

pub fn move_right_end(&mut self)

pub fn move_x(&mut self, x: usize)

pub fn move_y(&mut self, y: usize)

pub fn move_up(&mut self)

pub fn move_down(&mut self)

pub fn move_up_clamped(&mut self)

pub fn clamp_position(&self, loc: Point2<usize>) -> Point2<usize>

pub fn move_down_clamped(&mut self)

pub fn set_position(&mut self, pos: Point2<usize>)

pub fn set_position_clamped(&mut self, pos: Point2<usize>)

set the position to the max_column of the line if it is out of bounds

pub fn command_break_line(&mut self, loc: Point2<usize>)

pub fn command_join_line(&mut self, loc: Point2<usize>)

pub fn command_delete_back(&mut self) -> Option<char>

pub fn command_delete_forward(&mut self) -> Option<char>

pub fn move_to(&mut self, pos: Point2<usize>)

move the cursor to position

pub fn clear(&mut self)

clear the contents of this text buffer

Trait Implementations

impl Clone for TextBuffer

fn clone(&self) -> TextBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TextBuffer

fn default() -> Self

Returns the “default value” for a type.

impl ToString for TextBuffer

fn to_string(&self) -> String

Converts the given value to a String.