Skip to main content

LineIndex

Struct LineIndex 

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

A line-start table over one text snapshot.

Rebuild one per text revision (Document does this automatically); conversions are then O(log lines) plus O(line length) for the column walk.

§Examples

use increparse_lsp::{LineIndex, PositionEncoding};
use lsp_types::Position;

let text = "héllo\nwörld";
let index = LineIndex::new(text);

// "héllo" is 6 bytes / 5 UTF-16 units; end of line 0:
assert_eq!(
    index.offset(text, Position::new(0, 5), PositionEncoding::Utf16),
    Some(6)
);
assert_eq!(
    index.position(text, 6, PositionEncoding::Utf16),
    Position::new(0, 5)
);

Implementations§

Source§

impl LineIndex

Source

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

Builds the index for text.

Source

pub fn line_count(&self) -> usize

Number of lines (a trailing newline starts a final empty line).

Source

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

Byte offset where line begins.

Source

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

Byte offset just past the last byte of line, excluding the line terminator.

Source

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

Converts a Position to a byte offset.

Out-of-range lines clamp to the last line; overshooting columns clamp to the end of the line (LSP clients legitimately send both while typing). Returns None only if position.line overflows u32.

Source

pub fn position( &self, text: &str, offset: usize, encoding: PositionEncoding, ) -> Position

Converts a byte offset to a Position.

Out-of-bounds offsets clamp to the text length; offsets inside a multibyte character or a line terminator round down to the char boundary before them.

Trait Implementations§

Source§

impl Clone for LineIndex

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LineIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for LineIndex

Source§

impl PartialEq for LineIndex

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LineIndex

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.