Struct Text

Source

pub struct Text {
    pub readonly: bool,
    /* private fields */
}

Fields§

§readonly: bool

Implementations§

Source §

pub fn assert_invariants(&self) -> Result<()>

Methods from Deref<Target = Rope>§

pub fn write_to<T>(&self, writer: T) -> Result<(), Error>
where T: Write,

Writes the contents of the Rope to a writer.

This is a convenience function, and provides no specific guarantees about performance or internal implementation aside from the runtime complexity listed below.

When more precise control over IO behavior, buffering, etc. is desired, you should handle IO yourself and use the [Chunks] iterator to iterate through the Rope’s contents.

Runs in O(N) time.

§Errors

If the writer returns an error, write_to stops and returns that error.

Note: some data may have been written even if an error is returned.

pub fn slice<R>(&self, byte_range: R) -> RopeSlice<'_>
where R: RangeBounds<usize>,

Gets an immutable slice of the Rope.

Uses range syntax, e.g. 2..7, 2.., etc.

§Example

let rope = Rope::from_str("Hello world!");
let slice = rope.slice(..5);

assert_eq!("Hello", slice);

Runs in O(log N) time.

§Panics

If the start of the range is greater than the end.
If the end of the range is out of bounds (i.e. end > len()).
If the range ends are not on char boundaries.

pub fn len(&self) -> usize

Length of the text in bytes.

Runs in O(1) time.

pub fn len_lines(&self, line_type: LineType) -> usize

Total number of lines in the text, according to the passed line type.

Runs in best case O(1) time, worst-case O(log N).

pub fn is_char_boundary(&self, byte_idx: usize) -> bool

Returns whether byte_idx is a char boundary.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn floor_char_boundary(&self, byte_idx: usize) -> usize

Returns the byte index of the closest char boundary less than or equal to byte_idx.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn ceil_char_boundary(&self, byte_idx: usize) -> usize

Returns the byte index of the closest char boundary greater than or equal to byte_idx.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn trailing_line_break_idx(&self, line_type: LineType) -> Option<usize>

If the text ends with a line break, returns its byte index. Otherwise returns None.

Note: a CRLF pair is always treated as a single unit, and thus this function will return the index of the CR in such cases, even with LineType::LF where CR is not on its own recognized as a line break.

Runs in O(log N) time.

pub fn byte(&self, byte_idx: usize) -> u8

Returns the byte at byte_idx.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx >= len()).

pub fn char(&self, byte_idx: usize) -> char

Returns the char at byte_idx.

Note that this takes a byte index, not a char index.

Runs in O(log N) time.

§Panics

If byte_idx is out of bounds (i.e. byte_idx >= len()).
If byte_idx is not a char boundary.

pub fn line(&self, line_idx: usize, line_type: LineType) -> RopeSlice<'_>

Returns the line at line_idx, according to the given line type.

Note: lines are zero-indexed.

Runs in O(log N) time.

§Panics

Panics if line_idx is out of bounds (i.e. line_idx >= len_lines()).

pub fn chunk(&self, byte_idx: usize) -> (&str, usize)

Returns the chunk containing the byte at byte_idx.

Also returns the byte index of the beginning of the chunk.

Note: for convenience, a one-past-the-end byte_idx returns the last chunk of the RopeSlice.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn byte_to_line_idx(&self, byte_idx: usize, line_type: LineType) -> usize

Returns the line index of the line that the given byte belongs to.

Notes:

Counts lines according to the passed line type.
Lines are zero-indexed. Therefore this is functionally equivalent to counting the line breaks before the specified byte.
byte_idx can be one-past-the-end, which will return the last line index.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn line_to_byte_idx(&self, line_idx: usize, line_type: LineType) -> usize

Returns the byte index of the start of the given line.

Notes:

Counts lines according to the passed line type.
Lines are zero-indexed.
line_idx can be one-past-the-end, which will return one-past-the-end byte index.

Runs in O(log N) time.

§Panics

Panics if line_idx is out of bounds (i.e. line_idx > len_lines()).

pub fn bytes(&self) -> Bytes<'_> ⓘ

Creates an iterator over the bytes of the Rope.

Runs in O(log N) time.

pub fn bytes_at(&self, byte_idx: usize) -> Bytes<'_> ⓘ

Creates an iterator over the bytes of the Rope, starting at byte byte_idx.

If byte_idx == len() then an iterator at the end of the Rope is created (i.e. next() will return None).

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn chars(&self) -> Chars<'_> ⓘ

Creates an iterator over the chars of the Rope.

Runs in O(log N) time.

pub fn chars_at(&self, byte_idx: usize) -> Chars<'_> ⓘ

Creates an iterator over the chars of the Rope, starting at byte_idx.

Note that this takes a byte index, not a char index.

If byte_idx == len() then an iterator at the end of the Rope is created (i.e. next() will return None).

Runs in O(log N) time.

§Panics

If byte_idx is out of bounds (i.e. byte_idx > len()).
If byte_idx is not a char boundary.

pub fn char_indices(&self) -> CharIndices<'_> ⓘ

Creates an iterator over the chars of the Rope and their byte positions.

On each call to next or prev this iterator returns the byte index where the returned character starts.

Runs in O(log N) time.

pub fn char_indices_at(&self, byte_idx: usize) -> CharIndices<'_> ⓘ

Creates an iterator over the chars of the Rope and their byte positions, starting at byte_idx.

Note that this takes a byte index, not a char index.

If byte_idx == len() then an iterator at the end of the Rope is created (i.e. next() will return None).

On each call to next or prev this iterator returns the byte index where the returned character starts.

Runs in O(log N) time.

§Panics

If byte_idx is out of bounds (i.e. byte_idx > len()).
If byte_idx is not a char boundary.

pub fn lines(&self, line_type: LineType) -> Lines<'_> ⓘ

Creates an iterator over the lines of the Rope.

Note: the iterator will iterate over lines according to the passed line type.

Runs in O(log N) time.

pub fn lines_at(&self, line_idx: usize, line_type: LineType) -> Lines<'_> ⓘ

Creates an iterator over the lines of the Rope, starting at line line_idx.

Notes:

The iterator will iterate over lines according to the passed line type.
If line_idx == len_lines() then an iterator at the end of the Rope is created (i.e. next() will return None).

Runs in O(log N) time.

§Panics

Panics if line_idx is out of bounds (i.e. line_idx > len_lines()).

pub fn chunks(&self) -> Chunks<'_> ⓘ

Creates an iterator over the chunks of the Rope.

Runs in O(log N) time.

pub fn chunks_at(&self, byte_idx: usize) -> (Chunks<'_>, usize)

Creates an iterator over the chunks of the Rope, with the iterator starting at the chunk containing byte_idx.

Also returns the byte index of the beginning of the chunk to be yielded by next().

If byte_idx == len() an iterator at the end of the Rope (yielding None on a call to next()) is created, and the returned byte index is the end of the text.

Runs in O(log N) time.

§Panics

Panics if byte_idx is out of bounds (i.e. byte_idx > len()).

pub fn chunk_cursor(&self) -> ChunkCursor<'_>

Creates a cursor for navigating the chunks of the text, starting on the first chunk.

Runs in O(log N) time.

pub fn chunk_cursor_at(&self, byte_idx: usize) -> ChunkCursor<'_>

Creates a cursor for navigating the chunks of the text, with the cursor starting at the chunk containing byte_idx.

For convenience, byte_idx == len() is accepted, and puts the cursor on the last chunk. Note that for non-zero-length texts this is redundant with byte_idx == len() - 1.

Runs in O(log N) time.