Struct SourceMap 

pub struct SourceMap { /* private fields */ }

A listing of source files which are used to get parsed into an UnresolvedPackage.

Implementations

impl SourceMap

pub fn new() -> SourceMap

Creates a new empty source map.

pub fn push_file(&mut self, path: &Path) -> Result<(), Error>

Reads the file path on the filesystem and appends its contents to this SourceMap.

pub fn push(&mut self, path: &Path, contents: impl Into<String>)

Appends the given contents with the given path into this source map.

The path provided is not read from the filesystem and is instead only used during error messages. Each file added to a SourceMap is used to create the final parsed package namely by unioning all the interfaces and worlds defined together. Note that each file has its own personal namespace, however, for top-level use and such.

pub fn push_str(&mut self, path: &str, contents: impl Into<String>)

Appends the given contents with the given source name into this source map.

The path provided is not read from the filesystem and is instead only used during error messages. Each file added to a SourceMap is used to create the final parsed package namely by unioning all the interfaces and worlds defined together. Note that each file has its own personal namespace, however, for top-level use and such.

pub fn append(&mut self, other: SourceMap) -> u32

Appends all sources from another SourceMap into this one.

Returns the byte offset that should be added to all Span.start and Span.end values from the appended source map to make them valid in the combined source map.

pub fn parse(self) -> Result<UnresolvedPackageGroup, (SourceMap, ParseError)>

Parses the files added to this source map into a UnresolvedPackageGroup.

On failure returns Err((self, e)) so the caller can use the source map for error formatting if needed.

pub fn render_location(&self, span: Span) -> String

Renders a span as a human-readable location string (e.g., “file.wit:10:5”).

pub fn source_files(&self) -> impl Iterator<Item = &Path>

Returns an iterator over all filenames added to this source map.

pub fn source_names(&self) -> impl Iterator<Item = &str>

Returns an iterator over all source names added to this source map.

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<(), Error>

Formats the value using the given formatter.

impl Default for SourceMap

fn default() -> SourceMap

Returns the “default value” for a type.

impl Eq for SourceMap

impl PartialEq for SourceMap

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SourceMap