History

Johann Hemmann bef355168a non_minimal_cfg		2024-01-19 17:31:01 +01:00
..
src	non_minimal_cfg	2024-01-19 17:31:01 +01:00
Cargo.toml	Use Cargo's [workspace.lints.*] to config clippy	2023-12-29 23:51:32 +09:00
README.md	line-index: Update README.md with suggestions	2024-01-07 15:38:40 +01:00

README.md

line-index

This crate is developed as part of rust-analyzer.

line-index is a library to convert between text offsets and corresponding line/column coordinates.

Installation

To add this crate to a project simply run cargo add line-index.

Usage

The main structure is LineIndex.

It is constructed with an UTF-8 string, but also supports UTF-16 and UTF-32 offsets.

Example

use line_index::LineIndex;

let line_index = LineIndex::new("This is a\nmulti-line\ntext.");
line_index.line_col(3.into()); // LineCol { line: 0, col: 3 }
line_index.line_col(13.into()); // LineCol { line: 1, col: 3 }
line_index.offset(LineCol { line: 2, col: 3 }); // Some (24)

SemVer

This crate uses semver versioning.