Struct SourceMap

pub struct SourceMap { /* private fields */ }

Available on crate feature source-tracking only.

Storage for Sources used and referenced in compiling a wright project.

Cloneing is cheap, since this uses an Arc internally.

Implementations

impl SourceMap

pub fn new() -> Self

Construct a new empty SourceMap.

pub fn add(&self, source: Source) -> SourceRef

Add a Source to this SourceMap and get a SourceRef to it after it’s added.

pub fn get(&self, id: SourceId) -> Option<SourceRef>

Get a reference to a Source stored in this SourceMap using it’s Source::id.

This is currently O(1) since SourceMap uses a DashMap internally.

Returns None if the Source with the given Source::id is not in this SourceMap.

Trait Implementations

impl Clone for SourceMap

fn clone(&self) -> SourceMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMap

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

Formats the value using the given formatter.

impl Default for SourceMap

fn default() -> SourceMap

Returns the “default value” for a type.

impl<'f> Files<'f> for SourceMap

Available on crate feature reporting only.

type FileId = SourceId

A unique identifier for files in the file provider. This will be used for rendering diagnostic::Labels in the corresponding source files.

type Name = FileName

The user-facing name of a file, to be displayed in diagnostics.

type Source = ImmutableString

The source code of a file.

fn name(&'f self, id: Self::FileId) -> Result<Self::Name, Error>

The user-facing name of a file.

fn source(&'f self, id: Self::FileId) -> Result<Self::Source, Error>

The source code of a file.

fn line_index( &'f self, id: Self::FileId, byte_index: usize, ) -> Result<usize, Error>

The index of the line at the given byte index. If the byte index is past the end of the file, returns the maximum line index in the file. This means that this function only fails if the file is not present.

fn line_range( &'f self, id: Self::FileId, line_index: usize, ) -> Result<Range<usize>, Error>

The byte range of line in the source of the file.

fn line_number( &'a self, id: Self::FileId, line_index: usize, ) -> Result<usize, Error>

The user-facing line number at the given line index. It is not necessarily checked that the specified line index is actually in the file.

fn column_number( &'a self, id: Self::FileId, line_index: usize, byte_index: usize, ) -> Result<usize, Error>

The user-facing column number at the given line index and byte index.

fn location( &'a self, id: Self::FileId, byte_index: usize, ) -> Result<Location, Error>

Convenience method for returning line and column number at the given byte index in the file.