Struct Rope 

pub struct Rope {
    lines: Vec<String>,
}

An implementation of a rope data structure, composed of lines of owned strings. This is used to implement text controls in Servo.

Fields

lines: Vec<String>

The lines of the rope. Each line is an owned string that ends with a newline (\n), apart from the last line which has no trailing newline.

Implementations

impl Rope

pub fn new(contents: impl Into<String>) -> Self

pub fn contents(&self) -> String

pub fn last_index(&self) -> RopeIndex

pub fn replace_range( &mut self, range: Range<RopeIndex>, string: impl Into<String>, ) -> RopeIndex

Replace the given range of RopeIndexs with the given string. Returns the RopeIndex of the end of the insertion.

fn delete_range(&mut self, range: Range<RopeIndex>)

pub fn slice<'a>( &'a self, start: Option<RopeIndex>, end: Option<RopeIndex>, ) -> RopeSlice<'a>

Create a RopeSlice for this Rope from start to end. If either of these is None, then the slice will extend to the extent of the rope.

pub fn chars<'a>(&'a self) -> RopeChars<'a>

pub fn is_empty(&self) -> bool

Return true if the Rope is empty or false otherwise. This will also return true if the contents of the Rope are a single empty line.

pub fn len_utf16(&self) -> Utf16CodeUnitLength

The total number of code units required to encode the content in utf16.

fn line(&self, index: usize) -> &str

fn line_for_index(&self, index: RopeIndex) -> &String

fn line_for_index_mut(&mut self, index: RopeIndex) -> &mut String

fn last_index_in_line(&self, line: usize) -> RopeIndex

fn start_of_following_line(&self, index: RopeIndex) -> RopeIndex

Return a RopeIndex which points to the start of the subsequent line. If the given RopeIndex is already on the final line, this will return the final index of the entire Rope.

fn end_of_preceding_line(&self, index: RopeIndex) -> RopeIndex

Return a RopeIndex which points to the end of preceding line. If already at the end of the first line, this will return the start index of the entire Rope.

pub fn move_by( &self, origin: RopeIndex, unit: RopeMovement, amount: isize, ) -> RopeIndex

fn move_by_lines(&self, origin: RopeIndex, lines_to_move: isize) -> RopeIndex

fn move_by_iterator( &self, origin: RopeIndex, unit: RopeMovement, amount: isize, ) -> RopeIndex

pub fn clamp_index(&self, rope_index: RopeIndex) -> RopeIndex

Given a RopeIndex, clamp it, meaning that its indices are all bound by the actual size of the line and the number of lines in this Rope.

pub fn index_to_utf8_offset(&self, rope_index: RopeIndex) -> Utf8CodeUnitLength

Convert a RopeIndex into a byte offset from the start of the content.

pub fn index_to_utf16_offset( &self, rope_index: RopeIndex, ) -> Utf16CodeUnitLength

pub fn utf8_offset_to_rope_index( &self, utf8_offset: Utf8CodeUnitLength, ) -> RopeIndex

Convert a byte offset from the start of the content into a RopeIndex.

pub fn utf16_offset_to_utf8_offset( &self, utf16_offset: Utf16CodeUnitLength, ) -> Utf8CodeUnitLength

pub fn relevant_word_boundaries<'a>(&'a self, index: RopeIndex) -> RopeSlice<'a>

Find the boundaries of the word most relevant to the given RopeIndex. Word returned in order or precedence:

• If the index intersects the word or is the index directly preceding a word, the boundaries of that word are returned.
• The word preceding the cursor.
• If there is no word preceding the cursor, the start of the line to the end of the next word.

pub fn line_boundaries<'a>(&'a self, index: RopeIndex) -> RopeSlice<'a>

Return the boundaries of the line that contains the given RopeIndex.

Trait Implementations

impl MallocSizeOf for Rope

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.