Struct SourceMap 

pub struct SourceMap { /* private fields */ }

A source mapping detached from a Program.

A source map records the file table, the program shape, and the position-keyed spans of a span-bearing program. Extract it with SourceMap::extract, carry it beside the emitted Workshop text, and apply it to a program parsed from that text. Spans use Position units: 1-based lines and columns counted in Unicode scalar values.

The mapping granularity is rule, condition, action, direct action argument, and variable and subroutine declarations. Nodes without an authored origin have no entry, so consumers report evidence on them as unmapped.

Implementations

impl SourceMap

pub fn extract(program: &Program) -> Self

Extract the current mapping of a span-bearing program.

Only spans that are still valid for the program’s current shape are extracted; see Program::rule_span.

pub fn files(&self) -> &[String]

The paths of the file table that mapped spans refer to by file index.

pub fn apply(&self, program: &mut Program) -> Result<(), SourceMapError>

Replace the source mapping of program with this map.

The program’s file table becomes this map’s file table, and nodes without an entry carry no span. The program must have exactly the shape the map was extracted from; otherwise the whole mapping is rejected and program is unchanged.

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 Eq for SourceMap

impl PartialEq for SourceMap

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SourceMap