[][src]Module syntax::source_map

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

The SourceMap tracks all the source code used within a single crate, mapping from integer byte positions to the original source code location. Each bit of source parsed during crate parsing (typically files, in-memory strings, or various bits of macro expansion) cover a continuous range of bytes in the SourceMap and are represented by SourceFiles. Byte positions are stored in Span and used pervasively in the compiler. They are absolute positions within the SourceMap, which upon request can be converted to line and column information, source code snippets, etc.

Modules

editionInternal
fatal_errorInternal
hygieneInternal

Machinery for hygienic macros, inspired by the MTWT[1] paper.

symbolInternal

An "interner" is a data structure that associates values with usize tags and allows bidirectional lookup; i.e., given a value, one can easily find the type, and vice versa.

Structs

BytePosInternal

A byte offset. Keep this small (currently 32-bits), as AST contains a lot of them.

CachingSourceMapViewInternal
CharPosInternal

A character offset. Because of multibyte UTF-8 characters, a byte offset is not equivalent to a character offset. The SourceMap will convert BytePos values to CharPos values as necessary.

DistinctSourcesInternal
ExpnDataInternal

A subset of properties from both macro definition and macro call available through global data. Avoid using this if you have access to the original definition or call structures.

FileLinesInternal
FilePathMappingInternal
GlobalsInternal
InnerSpanInternal

Range inside of a Span used for diagnostics when we only have access to relative positions.

LineInfoInternal
LocInternal

A source code location used for error reporting.

MacroBacktraceInternal
MalformedSourceMapPositionsInternal
MultiByteCharInternal

Identifies an offset of a multi-byte character in a SourceFile.

MultiSpanInternal

A collection of spans. Spans have two orthogonal attributes:

NormalizedPosInternal

Identifies an offset of a character that was normalized away from SourceFile.

OffsetOverflowErrorInternal
RealFileLoaderInternal

A FileLoader that uses std::fs to load real files.

SourceFileInternal

A single source in the SourceMap.

SourceFileAndBytePosInternal
SourceFileAndLineInternal
SourceMapInternal
SpanInternal

A compressed span.

SpanDataInternal

Spans represent a region of code, used for error reporting. Positions in spans are absolute positions from the beginning of the source_map, not positions relative to SourceFiles. Methods on the SourceMap can be used to relate spans back to the original source. You must be careful if the span crosses more than one file - you will not be able to use many of the functions on spans in source_map and you cannot assume that the length of the span = hi - lo; there may be space in the BytePos range between files.

SpanLabelInternal
SpannedInternal
StableSourceFileIdInternal

Enums

ExpnKindInternal

Expansion kind.

ExternalSourceInternal

The state of the lazy external source loading mechanism of a SourceFile.

FileNameInternal

Differentiates between real files and common virtual files.

NonNarrowCharInternal

Identifies an offset of a non-narrow character in a SourceFile.

SpanLinesErrorInternal
SpanSnippetErrorInternal

Constants

DUMMY_SPInternal

Dummy span, both position and length are zero, syntax context is zero as well.

SPAN_DEBUGInternal

Statics

GLOBALSInternal

Traits

FileLoaderInternal

An abstraction over the fs operations used by the Parser.

HashStableContextInternal

Requirements for a StableHashingContext to be used in this crate. This is a hack to allow using the HashStable_Generic derive macro instead of implementing everything in librustc.

PosInternal

Functions

default_span_debugInternal
dummy_spannedInternal
original_spInternal

Returns the span itself if it doesn't come from a macro expansion, otherwise return the call site span up to the enclosing_sp by following the expn_data chain.

respanInternal

Type Definitions

FileLinesResultInternal