Struct TextRope 

pub struct TextRope { /* private fields */ }

Text store with a rope.

Implementations

impl TextRope

pub fn new() -> TextRope

New empty.

pub fn new_text(t: &str) -> TextRope

New from string.

pub fn new_rope(r: Rope) -> TextRope

New from rope.

pub fn rope(&self) -> &Rope

Borrow the rope

Trait Implementations

impl Clone for TextRope

fn clone(&self) -> TextRope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRope

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

Formats the value using the given formatter.

impl Default for TextRope

fn default() -> TextRope

Returns the “default value” for a type.

impl TextStore for TextRope

fn is_multi_line(&self) -> bool

Can store multi-line content?

If this returns false it is an error to call any function with a row other than 0.

fn cache_validity(&self) -> Option<usize>

Minimum byte position that has been changed since the last call of min_changed().

Used to invalidate caches.

fn string(&self) -> String

Content as string.

fn set_string(&mut self, t: &str)

Set content.

fn byte_range_at(&self, pos: TextPosition) -> Result<Range<usize>, TextError>

Grapheme position to byte position. This is the (start,end) position of the single grapheme after pos.

• pos must be a valid position: row <= len_lines, col <= line_width of the row.

fn byte_range(&self, range: TextRange) -> Result<Range<usize>, TextError>

Grapheme range to byte range.

• range must be a valid range. row <= len_lines, col <= line_width of the row.

fn byte_to_pos(&self, byte_pos: usize) -> Result<TextPosition, TextError>

Byte position to grapheme position. Returns the position that contains the given byte index.

• byte must <= byte-len.

fn bytes_to_range(&self, bytes: Range<usize>) -> Result<TextRange, TextError>

Byte range to grapheme range.

• byte must <= byte-len.

fn str_slice(&self, range: TextRange) -> Result<Cow<'_, str>, TextError>

A range of the text as Cow<str>.

• range must be a valid range. row <= len_lines, col <= line_width of the row.
• pos must be inside of range.

fn str_slice_byte(&self, range: Range<usize>) -> Result<Cow<'_, str>, TextError>

A range of the text as Cow<str>.

The byte-range must be a valid range.

fn graphemes_byte( &self, range: Range<usize>, pos: usize, ) -> Result<<TextRope as TextStore>::GraphemeIter<'_>, TextError>

Return a cursor over the graphemes of the range, start at the given position.

• range must be a valid byte-range.
• pos must be inside of range.

fn line_at(&self, row: u32) -> Result<Cow<'_, str>, TextError>

Line as str.

• row must be <= len_lines

fn lines_at( &self, row: u32, ) -> Result<impl Iterator<Item = Cow<'_, str>>, TextError>

Iterate over text-lines, starting at line-offset.

• row must be <= len_lines

fn line_graphemes( &self, row: u32, ) -> Result<<TextRope as TextStore>::GraphemeIter<'_>, TextError>

Return a line as an iterator over the graphemes. This contains the ‘\n’ at the end.

• row must be <= len_lines

fn line_width(&self, row: u32) -> Result<u32, TextError>

Line width as grapheme count. Excludes the terminating ‘\n’.

• row must be <= len_lines

fn insert_char( &mut self, pos: TextPosition, ch: char, ) -> Result<(TextRange, Range<usize>), TextError>

Insert a char at the given position.

• range must be a valid range. row <= len_lines, col <= line_width of the row.

fn insert_str( &mut self, pos: TextPosition, txt: &str, ) -> Result<(TextRange, Range<usize>), TextError>

Insert a text str at the given position.

• range must be a valid range. row <= len_lines, col <= line_width of the row.

fn remove( &mut self, range: TextRange, ) -> Result<(String, (TextRange, Range<usize>)), TextError>

Remove the given text range.

• range must be a valid range. row <= len_lines, col <= line_width of the row.

fn insert_b(&mut self, byte_pos: usize, t: &str) -> Result<(), TextError>

Insert a string at the given byte index. Call this only for undo.

byte_pos must be <= len bytes.

fn remove_b(&mut self, byte_range: Range<usize>) -> Result<(), TextError>

Remove the given byte-range. Call this only for undo.

byte_pos must be <= len bytes.

type GraphemeIter<'a> = RopeGraphemes<'a>

fn has_final_newline(&self) -> bool

Is there a line-break at the end of the text?

fn len_bytes(&self) -> usize

Length in bytes

fn len_lines(&self) -> u32

Number of lines.