Expand description
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::ExpnInfo;pub use hygiene::ExpnFormat;pub use hygiene::NameAndSpan;
Modules§
- hygiene
- Machinery for hygienic macros, inspired by the MTWT[1] paper.
- 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.
- CharPos
- A character offset. Because of multibyte utf8 characters, a byte offset is not equivalent to a character offset. The CodeMap will convert BytePos values to CharPos values as necessary.
- Distinct
Sources - File
Lines - FileMap
- A single source in the CodeMap.
- File
MapAnd Byte Pos - File
MapAnd Line - Line
Info - Loc
- A source code location used for error reporting
- LocWith
Opt - A source code location used as the result of lookup_char_pos_adj
- Macro
Backtrace - Malformed
Codemap Positions - Multi
Byte Char - Identifies an offset of a multi-byte character in a FileMap
- Multi
Span - A collection of spans. Spans have two orthogonal attributes:
- Span
- Spans represent a region of code, used for error reporting. Positions in spans are absolute positions from the beginning of the codemap, not positions relative to FileMaps. Methods on the CodeMap 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 codemap and you cannot assume that the length of the span = hi - lo; there may be space in the BytePos range between files.
- Span
Label