Struct SourceMap 

pub struct SourceMap { /* private fields */ }

Where every token of the expanded stream came from.

Implementations

impl SourceMap

pub const ROOT: FileId

The file a unit is: the first one read.

pub const fn new() -> Self

An empty map.

pub fn add_file(&mut self, path: &str, text: &str) -> FileId

Record a file, returning its id.

pub fn path(&self, file: FileId) -> Option<&str>

A file’s recorded path.

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

A file’s text.

pub fn origin(&self, index: usize) -> Option<&Origin>

Where the token at index in the expanded stream came from.

pub fn len(&self) -> usize

How many tokens the map covers.

pub fn is_empty(&self) -> bool

Whether the map covers nothing.

pub fn original(&self, expanded: Span) -> Option<(FileId, Span)>

Where a range of the expanded text was written: the file and the range in that file’s own text.

A range that starts inside a token written as it stands maps octet for octet; one that starts inside a macro’s expansion maps to the invocation, which is the text a reader can find. A range over several tokens of one file runs from the first to the last; one that leaves its file — a declaration whose body an include supplied — keeps the file it starts in. None before the first token, which a diagnostic of an empty unit points at.

pub fn origin_at(&self, at: u32) -> Option<&Origin>

The origin of the range of the expanded text that holds at: the file, where in it, and the macro expansions that made the text, outermost first. None before the first token.

Trait Implementations

impl Clone for SourceMap

fn clone(&self) -> Self

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() -> Self

Returns the “default value” for a type.