Skip to main content

SourceMap

Struct SourceMap 

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

Pre-computed index of line-start byte offsets for a source string.

Construction is O(n) in the source length. Each lookup is O(log n) in the number of lines (binary search), which is effectively O(1) for typical files.

Implementations§

Source§

impl SourceMap

Source

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

Build an index from the given source text.

Source

pub fn empty() -> Self

A no-op map for callers that never query line/column positions. Used when ParseOptions::source_map is false. offset_to_line_col on an empty map returns LineCol { line: 0, col: offset }.

Source

pub fn line_count(&self) -> usize

Total number of lines in the source.

Source

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

Byte offset where the given 0-based line starts. Returns None if the line is out of range.

Source

pub fn offset_to_line_col(&self, offset: u32) -> LineCol

Convert a byte offset to a 0-based line/column.

If offset is past the end of the source, the position is clamped to the last line.

Source

pub fn span_to_line_col(&self, span: Span) -> LineColSpan

Convert a Span to a start/end LineColSpan.

Source

pub fn line_col_to_offset(&self, lc: LineCol) -> Option<u32>

Convert a 0-based line/column to a byte offset; None past the line’s \n or the end of the source.

Trait Implementations§

Source§

impl Clone for SourceMap

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 SourceMap

Source§

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

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

impl Eq for SourceMap

Source§

impl PartialEq for SourceMap

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 SourceMap

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.