[][src]Crate rustc_span

Source positions and related helper functions.

Important concepts in this module include:

Unlike most compilers, the span contains not only the position in the source code, but also various other metadata, such as the edition and macro hygiene. This metadata is stored in SyntaxContext and ExpnData.

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.

lev_distance

Levenshtein distances.

source_map

Types for tracking pieces of source code within a crate.

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.

CachingSourceMapView
CharPos

A character offset.

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

Represents a span.

SpanLabel

A span together with some additional data.

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.

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