Struct LineIndex 

pub struct LineIndex { /* private fields */ }

Source text plus a line-start index, supporting byte ↔ Position conversion.

Owns the text so it can serve slices and per-line lookups without the caller also threading a &str through. This is the same memory profile as the old RopeC(Rope) (which already duplicated the Source string).

Implementations

impl LineIndex

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

Build an index over text, scanning once for line breaks (O(n)).

pub fn as_str(&self) -> &str

The full source text.

pub fn len_bytes(&self) -> usize

Total length in bytes.

pub fn len_lines(&self) -> usize

Number of lines (a trailing newline counts as starting one more line).

pub fn line_start(&self, line: usize) -> Option<usize>

Byte offset at which line starts, or None if out of range. A one-past-the-end line is not accepted (use [len_bytes] for that).

pub fn line_byte_range(&self, line: usize) -> Option<Range<usize>>

Byte range [start, end) of line, including its trailing newline (if any).

pub fn line_str(&self, line: usize) -> Option<&str>

Text of line, including its trailing newline (if any).

pub fn byte_slice(&self, range: Range<usize>) -> Option<&str>

Sub-slice by byte range. Returns None for out-of-bounds ranges or ranges that do not fall on char boundaries.

pub fn char_at_byte(&self, byte: usize) -> Option<char>

The char starting at byte offset byte, if byte is a char boundary within the text.

pub fn byte_to_position( &self, byte: usize, encoding: PositionEncoding, ) -> Option<Position>

Convert a byte offset to an LSP Position in the given encoding.

Accepts byte == len_bytes() (end of document). Returns None if byte is out of range or not on a char boundary.

pub fn position_to_byte( &self, position: Position, encoding: PositionEncoding, ) -> Option<usize>

Convert an LSP Position (interpreted in encoding) to a byte offset.

A character past the end of its line is clamped to the line’s end (which keeps the lenient behaviour editors rely on when the cursor sits after the last character). Returns None only if the line itself is out of range.

Trait Implementations

impl AsMut<LineIndex> for RopeC

fn as_mut(&mut self) -> &mut LineIndex

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<LineIndex> for RopeC

fn as_ref(&self) -> &LineIndex

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LineIndex

fn clone(&self) -> LineIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineIndex

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

Formats the value using the given formatter.

impl Default for LineIndex

fn default() -> LineIndex

Returns the “default value” for a type.