Struct syntax::codemap::CodeMap

pub struct CodeMap { /* fields omitted */ }

Methods

impl CodeMap

pub fn new(path_mapping: FilePathMapping) -> CodeMap

pub fn new_doctest(     path_mapping: FilePathMapping,     file: FileName,     line: isize ) -> CodeMap

pub fn with_file_loader(     file_loader: Box<FileLoader + Sync + Send>,     path_mapping: FilePathMapping ) -> CodeMap

pub fn path_mapping(&self) -> &FilePathMapping

pub fn file_exists(&self, path: &Path) -> bool

pub fn load_file(&self, path: &Path) -> Result<Lrc<FileMap>>

pub fn files(&self) -> LockGuard<Vec<Lrc<FileMap>>>

pub fn filemap_by_stable_id(     &self,     stable_id: StableFilemapId ) -> Option<Lrc<FileMap>>

pub fn new_filemap(&self, filename: FileName, src: String) -> Lrc<FileMap>

Creates a new filemap without setting its line information. If you don't intend to set the line information yourself, you should use new_filemap_and_lines. This does not ensure that only one FileMap exists per file name.

pub fn new_filemap_and_lines(&self, filename: &Path, src: &str) -> Lrc<FileMap>

Creates a new filemap and sets its line information. This does not ensure that only one FileMap exists per file name.

pub fn new_imported_filemap(     &self,     filename: FileName,     name_was_remapped: bool,     crate_of_origin: u32,     src_hash: u128,     name_hash: u128,     source_len: usize,     file_local_lines: Vec<BytePos>,     file_local_multibyte_chars: Vec<MultiByteChar>,     file_local_non_narrow_chars: Vec<NonNarrowChar> ) -> Lrc<FileMap>

Allocates a new FileMap representing a source file from an external crate. The source code of such an "imported filemap" is not available, but we still know enough to generate accurate debuginfo location information for things inlined from other crates.

pub fn mk_substr_filename(&self, sp: Span) -> String

pub fn doctest_offset_line(&self, orig: usize) -> usize

pub fn lookup_char_pos(&self, pos: BytePos) -> Loc

Lookup source information about a BytePos

pub fn lookup_line(&self, pos: BytePos) -> Result<FileMapAndLine, Lrc<FileMap>>

pub fn lookup_char_pos_adj(&self, pos: BytePos) -> LocWithOpt

pub fn merge_spans(&self, sp_lhs: Span, sp_rhs: Span) -> Option<Span>

Returns Some(span), a union of the lhs and rhs span. The lhs must precede the rhs. If there are gaps between lhs and rhs, the resulting union will cross these gaps. For this to work, the spans have to be:

• the ctxt of both spans much match
• the lhs span needs to end on the same line the rhs span begins
• the lhs span must start at or before the rhs span

pub fn span_to_string(&self, sp: Span) -> String

pub fn span_to_filename(&self, sp: Span) -> FileName

pub fn span_to_unmapped_path(&self, sp: Span) -> FileName

pub fn is_multiline(&self, sp: Span) -> bool

pub fn span_to_lines(&self, sp: Span) -> FileLinesResult

pub fn span_to_snippet(&self, sp: Span) -> Result<String, SpanSnippetError>

Return the source snippet as String corresponding to the given Span

pub fn span_to_prev_source(&self, sp: Span) -> Result<String, SpanSnippetError>

Return the source snippet as String before the given Span

pub fn span_extend_to_prev_char(&self, sp: Span, c: char) -> Span

Extend the given Span to just after the previous occurrence of c. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_extend_to_prev_str(     &self,     sp: Span,     pat: &str,     accept_newlines: bool ) -> Span

Extend the given Span to just after the previous occurrence of pat when surrounded by whitespace. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_until_char(&self, sp: Span, c: char) -> Span

Given a Span, try to get a shorter span ending before the first occurrence of c char

pub fn span_through_char(&self, sp: Span, c: char) -> Span

Given a Span, try to get a shorter span ending just after the first occurrence of char c.

pub fn span_until_non_whitespace(&self, sp: Span) -> Span

Given a Span, get a new Span covering the first token and all its trailing whitespace or the original Span.

If sp points to "let mut x", then a span pointing at "let " will be returned.

pub fn span_until_whitespace(&self, sp: Span) -> Span

Given a Span, get a new Span covering the first token without its trailing whitespace or the original Span in case of error.

If sp points to "let mut x", then a span pointing at "let" will be returned.

pub fn span_take_while<P>(&self, sp: Span, predicate: P) -> Span where     P: for<'r> FnMut(&'r char) -> bool,

Given a Span, get a shorter one until predicate yields false.

pub fn def_span(&self, sp: Span) -> Span

pub fn end_point(&self, sp: Span) -> Span

Returns a new span representing just the end-point of this span

pub fn next_point(&self, sp: Span) -> Span

Returns a new span representing the next character after the end-point of this span

pub fn get_filemap(&self, filename: &FileName) -> Option<Lrc<FileMap>>

pub fn lookup_byte_offset(&self, bpos: BytePos) -> FileMapAndBytePos

For a global BytePos compute the local offset within the containing FileMap

pub fn bytepos_to_file_charpos(&self, bpos: BytePos) -> CharPos

Converts an absolute BytePos to a CharPos relative to the filemap.

pub fn lookup_filemap_idx(&self, pos: BytePos) -> usize

pub fn count_lines(&self) -> usize

pub fn generate_fn_name_span(&self, span: Span) -> Option<Span>

pub fn generate_local_type_param_snippet(     &self,     span: Span ) -> Option<(Span, String)>

Take the span of a type parameter in a function signature and try to generate a span for the function name (with generics) and a new snippet for this span with the pointed type parameter as a new local type parameter.

For instance:

// Given span
fn my_function(param: T)
//                    ^ Original span

// Result
fn my_function(param: T)
// ^^^^^^^^^^^ Generated span with snippet `my_function<T>`

Attention: The method used is very fragile since it essentially duplicates the work of the parser. If you need to use this function or something similar, please consider updating the codemap functions and this function to something more robust.

Trait Implementations

impl CodeMapper for CodeMap

fn lookup_char_pos(&self, pos: BytePos) -> Loc

fn span_to_lines(&self, sp: Span) -> FileLinesResult

fn span_to_string(&self, sp: Span) -> String

fn span_to_filename(&self, sp: Span) -> FileName

fn merge_spans(&self, sp_lhs: Span, sp_rhs: Span) -> Option<Span>

fn call_span_if_macro(&self, sp: Span) -> Span

fn ensure_filemap_source_present(&self, file_map: Lrc<FileMap>) -> bool

fn doctest_offset_line(&self, line: usize) -> usize