Struct SourceMap 

pub struct SourceMap { /* private fields */ }

Implementations

impl SourceMap

pub fn new() -> SourceMap

pub fn add( &mut self, name: impl Into<String>, text: impl Into<String>, ) -> FileId

pub fn name(&self, file: FileId) -> &str

pub fn find(&self, name: &str) -> Option<FileId>

The file this map holds under name, if it holds one.

For a caller that has a span and needs to know which file it is in rather than what it says: an editor answering a question about one document holds spans from every module the project linked, and two files’ byte offsets overlap by construction. Compares whole names rather than suffixes, because a FileId that is nearly right is a span pointing into the wrong buffer.

pub fn text(&self, file: FileId) -> &str

pub fn line_col(&self, file: FileId, offset: u32) -> (usize, usize)

1-based line and column (column counted in characters, not bytes).

A span from a file this map does not hold reports 1:1 rather than panicking. That is a compiler defect wherever it happens — a diagnostic that cannot be located is a diagnostic nobody can act on — but the failure belongs in the message, not in a crash during rendering.

Trait Implementations

impl Clone for SourceMap

fn clone(&self) -> SourceMap

Returns a duplicate 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.