Skip to main content

LineOffsetTable

Struct LineOffsetTable 

Source
pub struct LineOffsetTable { /* private fields */ }
Expand description

Converts byte offsets in source text to LSP Position values.

Precomputes line-start byte offsets once, then maps any byte offset to a (line, character) position. Characters are counted as UTF-16 code units as required by the LSP specification.

Also precomputes, per line, whether that line is pure ASCII (line_is_ascii): for an ASCII-only line, byte offset and UTF-16 code-unit offset are always equal, so byte_offset_to_position can skip the chars().map(char::len_utf16).sum() scan entirely and compute the character offset in O(1). This matters because a single minified manifest line (e.g. a package.json with hundreds of dependencies on one line) turns per-offset lookups into an O(n) scan each, and O(n) lookups across the line’s length make the whole document O(n^2) (#742) — the common case of an ASCII-only line now stays O(1) per lookup; a non-ASCII line still takes an O(1) lookup too, via a lazily-built per-line index (#882) — see with_non_ascii_line_index.

Interior mutability: this type is Send but not Sync (the non-ASCII line index cache uses a RefCell). Build one per document parse and never share it across threads.

Implementations§

Source§

impl LineOffsetTable

Source

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

Builds the table for content.

Source

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

Absolute byte offset where line (0-indexed) starts, or None if line is out of range.

Prefer this over re-deriving a line’s start via cursor arithmetic (cursor += line.len() + 1): str::lines() strips a trailing \r, so that approach under-counts by one byte per CRLF line and corrupts every subsequent offset in the file. This table is built by scanning char_indices() for \n (see new), which counts the \r, so it stays correct for LF, CRLF and mixed line endings alike.

§Examples
use deps_core::lsp_helpers::LineOffsetTable;

let table = LineOffsetTable::new("a\r\nb\r\nc");
assert_eq!(table.line_start(0), Some(0));
assert_eq!(table.line_start(1), Some(3));
assert_eq!(table.line_start(2), Some(6));
assert_eq!(table.line_start(3), None);
Source

pub fn byte_offset_to_position(&self, content: &str, offset: usize) -> Position

Converts a byte offset into an LSP Position.

Source

pub fn position_to_byte_offset( &self, content: &str, position: Position, ) -> usize

Converts an LSP Position back into a byte offset — the inverse of byte_offset_to_position. Out-of-range lines or UTF-16 characters clamp to content.len() rather than panicking, matching the forward conversion’s .min(content.len()) guard.

A character landing inside a surrogate pair rounds up to the next char boundary, and one past the line’s end (including its \n) resolves to the line’s end — the same results as utf16_to_byte_offset on the line, but O(1) on an ASCII line and O(log line length) on a non-ASCII one via the cached per-line index (#1711).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more