Struct SourceMap 

pub struct SourceMap<'a> { /* private fields */ }

A line-indexed view of a parsed source.

Byte offsets are zero-based UTF-8 offsets. Lines and columns are one-based, and columns count Unicode scalar values, not bytes. End positions point to the location immediately after the covered byte range.

Implementations

impl<'a> SourceMap<'a>

pub fn anonymous(input: &'a str) -> Self

Create an anonymous source map.

pub fn new( source: Option<SourceId>, name: Option<Cow<'a, str>>, input: &'a str, ) -> Self

Create a source map with a document-local source identifier and optional name.

pub const fn source_id(&self) -> Option<SourceId>

Return this source’s identifier, when it has one.

pub fn name(&self) -> Option<&str>

Return this source’s caller-provided name.

pub const fn len(&self) -> usize

Return the number of bytes in the source.

pub const fn input(&self) -> &'a str

Return the underlying source text.

pub const fn is_empty(&self) -> bool

Return true when this source is empty.

pub fn line_column(&self, byte: usize) -> (usize, usize)

Return the line and column for a byte offset.

Offsets past end-of-file are clamped to the end of the source.

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

Return the byte offset for a one-based line and column.

Columns count Unicode scalar values. A column one past the end of the line resolves to the line-end byte offset.

pub fn span(&self, byte_start: usize, byte_end: usize) -> SourceSpan

Create a source span for a byte range.

The range is clamped to the source length. The returned span keeps the half-open byte offsets and one-based start/end line-column positions.

pub fn slice(&self, span: SourceSpan) -> Option<&'a str>

Return a borrowed slice for a source span when it belongs to this source.

pub fn snippet(&self, span: SourceSpan, max_chars: usize) -> Option<String>

Return a short line-oriented snippet for a span.

Trait Implementations

impl<'a> Clone for SourceMap<'a>

fn clone(&self) -> SourceMap<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SourceMap<'a>

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

Formats the value using the given formatter.