Struct LineIndex 

pub struct LineIndex { /* private fields */ }

Precomputed line, character, and UTF-16 offset tables for a source string.

Byte offsets passed to LineIndex::line_col and LineIndex::char_line_col are clamped to the source length, and LineIndex::utf16_range clamps ranges to source bounds. LineIndex::utf16_col is deliberately fallible for line/column pairs and returns CoordinateRangeError when the pair is outside this source.

Implementations

impl LineIndex

pub fn new(source: &str) -> Self

Builds line and column lookup tables for source.

pub const fn source_len_bytes(&self) -> ByteOffset

Source length in bytes, represented as the EOF byte offset.

pub fn line_col(&self, offset: TextSize) -> ByteLineCol

Maps a byte offset to a 1-based line and byte column, clamping past EOF.

pub fn char_line_col(&self, offset: TextSize) -> CharLineCol

Maps a byte offset to a 1-based line and Unicode scalar column.

Non-UTF-8-boundary offsets snap to the previous character boundary.

pub fn utf16_col( &self, line: LineNumber, byte_col: ByteColumn, ) -> Result<Utf16Offset, CoordinateRangeError>

Returns the UTF-16 code-unit offset from the start of line to byte_col.

Both coordinates must be within this source. Zero cannot be represented by LineNumber or ByteColumn, and this method returns a typed error instead of clamping lines or columns past the source.

Errors

Returns CoordinateRangeError when line is past the source line count or byte_col is past the end column for that line.

pub fn utf16_range(&self, range: TextRange) -> Utf16Range

Maps a byte range to UTF-16 start/end offsets, clamping to source bounds.

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

Formats the value using the given formatter.

impl Eq for LineIndex

impl PartialEq for LineIndex

fn eq(&self, other: &LineIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LineIndex