[][src]Crate rustc_span

The source positions and related helper functions.

Note

This API is completely unstable and subject to change.

Re-exports

pub use hygiene::SyntaxContext;
pub use hygiene::DesugaringKind;
pub use hygiene::ExpnData;
pub use hygiene::ExpnId;
pub use hygiene::ExpnKind;
pub use hygiene::ForLoopLoc;
pub use hygiene::MacroKind;
pub use symbol::sym;
pub use symbol::Symbol;

Modules

analyze_source_file
caching_source_map_view
def_id
edition
fatal_error
hygiene

Machinery for hygienic macros.

source_map

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.

span_encoding
symbol

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

BytePos

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

CachingSourceMapView
CharPos

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.

DistinctSources
FileLines
InnerSpan

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

LineInfo
Loc

A source code location used for error reporting.

MalformedSourceMapPositions
MultiByteChar

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

MultiSpan

A collection of Spans.

NormalizedPos

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

OffsetOverflowError
SessionGlobals
SourceFile

A single source in the SourceMap.

SourceFileAndBytePos
SourceFileAndLine
SourceFileHash

The hash of the on-disk source file used for debug info.

Span

A compressed span.

SpanData

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.

SpanLabel

Enums

ExternalSource
ExternalSourceKind

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

FileName

Differentiates between real files and common virtual files.

NonNarrowChar

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

RealFileName
SourceFileHashAlgorithm
SpanLinesError
SpanSnippetError

Constants

DUMMY_SP

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

Statics

SESSION_GLOBALS
SPAN_DEBUG

Traits

HashStableContext

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_middle.

Pos

Functions

debug_with_source_map
default_span_debug
lookup_line
normalize_newlines

Replaces \r\n with \n in-place in src.

normalize_src

Normalizes the source code and records the normalizations.

remove_bom

Removes UTF-8 BOM, if any.

with_default_session_globals
with_session_globals
with_source_map

Calls the provided closure, using the provided SourceMap to format any spans that are debug-printed during the closure's execution.

Type Definitions

FileLinesResult