Struct LineIndex 

pub struct LineIndex { /* private fields */ }

Line index for byte <-> (line, col) mapping.

Implementations

impl LineIndex

pub fn new(text: &str) -> LineIndex

Build a line index from UTF-8 text.

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

Convert a byte offset to (line, column) using byte columns.

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

Convert (line, column) back to byte offset.

Returns None when the line is out of range or when the column extends past the end of the line (including the newline character, but not the start of the next line).

pub fn position_to_byte_utf16( &self, text: &str, line: usize, column: usize, ) -> Option<usize>

Convert (line, column) back to byte offset where column is a UTF-16 code unit offset (the unit used by the LSP Position.character field).

This is the LSP-safe counterpart to position_to_byte, which uses raw byte columns. On lines that contain only ASCII, the two functions return identical results. On lines with multibyte UTF-8 characters the byte offset can be larger than the UTF-16 column number.

Parameters

• text — the original UTF-8 source text that was used to build this index. The caller must pass the same text that was given to new.
• line — 0-based line number.
• column — 0-based UTF-16 code unit offset from the start of the line.

Return value

Returns None when:

• line is out of range (same as position_to_byte).
• column is past the end of the line (UTF-16 length of the line text).
• column points into the middle of a UTF-16 surrogate pair (the interior of a supplementary character, U+10000..=U+10FFFF).

The returned byte offset is always on a UTF-8 character boundary.

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

Convert (line, column) back to byte offset, returning None when the column crosses the line boundary.

The newline character at the end of a line is the last addressable column on that line. The byte at next_line_start belongs to the next line and is therefore out of range.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.