Crate rustc_span 

Source positions and related helper functions.

Important concepts in this module include:

• the span, represented by SpanData and related types;
• source code as represented by a SourceMap; and
• interned strings, represented by Symbols, with some common symbols available statically in the sym module.

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(crate) use source_map::SourceMap; 🔒

pub(crate) use source_map::SourceMapInputs; 🔒

pub use self::caching_source_map_view::CachingSourceMapView;

pub(crate) use crate::def_id::DefPathHash; 🔒

pub(crate) use crate::fatal_error::FatalError; 🔒

pub(crate) use edition::Edition; 🔒

pub(crate) use hygiene::Transparency; 🔒

pub use hygiene::DesugaringKind;

pub use hygiene::ExpnData;

pub use hygiene::ExpnHash;

pub use hygiene::ExpnId;

pub use hygiene::ExpnKind;

pub use hygiene::LocalExpnId;

pub use hygiene::MacroKind;

pub use hygiene::SyntaxContext;

pub(crate) use def_id::CrateNum; 🔒

pub(crate) use def_id::DefId; 🔒

pub(crate) use def_id::DefIndex; 🔒

pub(crate) use def_id::LOCAL_CRATE; 🔒

pub(crate) use def_id::LocalDefId; 🔒

pub(crate) use def_id::StableCrateId; 🔒

pub use span_encoding::DUMMY_SP;

pub use span_encoding::OrdSpan;

pub use span_encoding::Span;

pub use symbol::ByteSymbol;

pub use symbol::Ident;

pub use symbol::MacroRulesNormalizedIdent;

pub use symbol::STDLIB_STABLE_CRATES;

pub use symbol::Symbol;

pub use symbol::kw;

pub use symbol::sym;

pub use macros::bug;

pub use macros::span_bug;

pub(crate) use span_encoding::InlineCtxt; 🔒

pub(crate) use DummyStableHashCtxt; 🔒

pub(crate) use StableHashCtxt; 🔒

pub(crate) use AtomicRef; 🔒

pub(crate) use outline; 🔒

pub(crate) use Decodable; 🔒

pub(crate) use Encodable; 🔒

pub(crate) use StableHash; 🔒

pub(crate) use rustc_serialize::opaque::mem_encoder::MemEncoder; 🔒

pub(crate) use FileEncoder; 🔒

pub(crate) use MemDecoder; 🔒

pub(crate) use Decodable; 🔒

pub(crate) use Decoder; 🔒

pub(crate) use Encodable; 🔒

pub(crate) use Encoder; 🔒

pub(crate) use tracing::debug; 🔒

pub(crate) use std::borrow::Cow; 🔒

pub(crate) use std::fmt::Display; 🔒

pub(crate) use std::hash::Hash; 🔒

pub(crate) use std::hash::Hash; 🔒

pub(crate) use io; 🔒

pub(crate) use Read; 🔒

pub(crate) use Add; 🔒

pub(crate) use Range; 🔒

pub(crate) use Sub; 🔒

pub(crate) use Path; 🔒

pub(crate) use PathBuf; 🔒

pub(crate) use std::str::FromStr; 🔒

pub(crate) use std::sync::Arc; 🔒

pub(crate) use cmp; 🔒

pub(crate) use fmt; 🔒

pub(crate) use iter; 🔒

pub(crate) use Digest; 🔒

pub(crate) use Md5; 🔒

pub(crate) use StableHash; 🔒

pub(crate) use StableHasher; 🔒

pub(crate) use FreezeLock; 🔒

pub(crate) use FreezeWriteGuard; 🔒

pub(crate) use Lock; 🔒

pub(crate) use rustc_data_structures::unord::UnordMap; 🔒

pub(crate) use Hash64; 🔒

pub(crate) use Hash128; 🔒

pub(crate) use sha1::Sha1; 🔒

pub(crate) use sha2::Sha256; 🔒

Modules

analyze_source_file 🔒

caching_source_map_view 🔒

def_id

edit_distance

Edit distances.

edition

fatal_error

hygiene

Machinery for hygienic macros.

macros

profiling

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.

Macros

impl_pos 🔒

Structs

AttrId

BytePos

A byte offset.

CharPos

A character offset.

DistinctSources

ErrorGuaranteed

Useful type to use with Result<> indicate that an error has already been reported to the user, so no need to continue checking.

FileLines

FileNameDisplay

InnerRealFileName 🔒

The inner workings of RealFileName.

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

MetavarSpansMap

MultiByteChar

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

NormalizedPos

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

OffsetOverflowError

RealFileName

A self-contained “real” filename.

RelativeBytePos

A byte offset relative to file beginning.

RemapPathScopeComponents

Scopes used to determined if it need to apply to --remap-path-prefix

SessionGlobals

Per-session global variables: this struct is stored in thread-local storage in such a way that it is accessible without any kind of handle to all threads within the compilation session, but is not accessible outside the session.

SourceFile

A single source in the SourceMap.

SourceFileAndBytePos

SourceFileAndLine

SourceFileDiffs

The source file lines in difference list form. This matches the form used within metadata, which saves space by exploiting the fact that the lines list is sorted and individual lines are usually not that long.

SourceFileHash

The hash of the on-disk source file used for debug info and cargo freshness checks.

SpanData

Represents a span.

Spanned

StableSourceFileId

This is a SourceFile identifier that is used to correlate source files between subsequent compilation sessions (which is something we need to do during incremental compilation).

Enums

ExternalSource

ExternalSourceKind

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

FileName

Differentiates between real files and common virtual files.

FileNameDisplayPreference 🔒

SourceFileHashAlgorithm

SourceFileLines

SpanLinesError

SpanSnippetError

Constants

UNICODE_VERSION

The version of Unicode that this version of unicode-width is based on.

Statics

SESSION_GLOBALS 🔒

SPAN_TRACK

Traits

BlobDecoder

Pos

SpanDecoder

This trait is used to allow decoder specific encodings of certain types. It is similar to rustc_type_ir’s TyDecoder.

SpanEncoder

This trait is used to allow encoder specific encodings of certain types. It is similar to rustc_type_ir’s TyEncoder.

Functions

char_width

create_default_session_globals_then

Default edition, no source map.

create_session_globals_then

create_session_if_not_set_then

No source map.

dummy_spanned

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.

respan

set_session_globals_then

str_width

with_metavar_spans

with_session_globals

Type Aliases

FileLinesResult