Skip to main content

LineIndex

Struct LineIndex 

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

Maps flat TextSize offsets to/from (line, column) representation.

Implementations§

Source§

impl LineIndex

Source

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

Returns a LineIndex for the text.

Source

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

Transforms the TextSize into a LineCol.

§Panics

If the offset is invalid. See Self::try_line_col.

Source

pub fn try_line_col(&self, offset: TextSize) -> Option<LineCol>

Transforms the TextSize into a LineCol.

Returns None if the offset was invalid, e.g. if it extends past the end of the text or points to the middle of a multi-byte character.

Source

pub fn offset(&self, line_col: LineCol) -> Option<TextSize>

Transforms the LineCol into a TextSize.

Source

pub fn to_wide( &self, enc: WideEncoding, line_col: LineCol, ) -> Option<WideLineCol>

Transforms the LineCol with the given WideEncoding into a WideLineCol.

Source

pub fn to_utf8( &self, enc: WideEncoding, line_col: WideLineCol, ) -> Option<LineCol>

Transforms the WideLineCol with the given WideEncoding into a LineCol.

Source

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

Returns the given line’s range.

Source

pub fn lines(&self, range: TextRange) -> impl Iterator<Item = TextRange> + '_

Given a range [start, end), returns a sorted iterator of non-empty ranges [start, x1), [x1, x2), …, [xn, end) where all the xi, which are positions of newlines, are inside the range [start, end).

Source

pub fn len(&self) -> TextSize

Returns the length of the original text.

Trait Implementations§

Source§

impl Clone for LineIndex

Source§

fn clone(&self) -> LineIndex

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: &LineIndex) -> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.