Struct rustc_ap_rustc_span::SourceFile

pub struct SourceFile {
    pub name: FileName,
    pub src: Option<Lrc<String>>,
    pub src_hash: SourceFileHash,
    pub external_src: Lock<ExternalSource>,
    pub start_pos: BytePos,
    pub end_pos: BytePos,
    pub lines: Vec<BytePos>,
    pub multibyte_chars: Vec<MultiByteChar>,
    pub non_narrow_chars: Vec<NonNarrowChar>,
    pub normalized_pos: Vec<NormalizedPos>,
    pub name_hash: u128,
    pub cnum: CrateNum,
}

A single source in the SourceMap.

Fields

name: FileName

The name of the file that the source came from. Source that doesn’t originate from files has names between angle brackets by convention (e.g., <anon>).

src: Option<Lrc<String>>

The complete source code.

src_hash: SourceFileHash

The source code’s hash.

external_src: Lock<ExternalSource>

The external source code (used for external crates, which will have a None value as self.src.

start_pos: BytePos

The start position of this source in the SourceMap.

end_pos: BytePos

The end position of this source in the SourceMap.

lines: Vec<BytePos>

Locations of lines beginnings in the source code.

multibyte_chars: Vec<MultiByteChar>

Locations of multi-byte characters in the source code.

non_narrow_chars: Vec<NonNarrowChar>

Width of characters that are not narrow in the source code.

normalized_pos: Vec<NormalizedPos>

Locations of characters removed during normalization.

name_hash: u128

A hash of the filename, used for speeding up hashing in incremental compilation.

cnum: CrateNum

Indicates which crate this SourceFile was imported from.

Implementations

impl SourceFile

pub fn new(
    name: FileName,
    src: String,
    start_pos: BytePos,
    hash_kind: SourceFileHashAlgorithm
) -> Self

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

Returns the BytePos of the beginning of the current line.

pub fn add_external_src<F>(&self, get_src: F) -> bool where
    F: FnOnce() -> Option<String>, 

Add externally loaded source. If the hash of the input doesn’t match or no input is supplied via None, it is interpreted as an error and the corresponding enum variant is set. The return value signifies whether some kind of source is present.

pub fn get_line(&self, line_number: usize) -> Option<Cow<'_, str>>

Gets a line from the list of pre-computed line-beginnings. The line number here is 0-based.

pub fn is_real_file(&self) -> bool

pub fn is_imported(&self) -> bool

pub fn count_lines(&self) -> usize

pub fn lookup_line(&self, pos: BytePos) -> Option<usize>

Finds the line containing the given position. The return value is the index into the lines array of this SourceFile, not the 1-based line number. If the source_file is empty or the position is located before the first line, None is returned.

pub fn line_bounds(&self, line_index: usize) -> Range<BytePos>

pub fn contains(&self, byte_pos: BytePos) -> bool

Returns whether or not the file contains the given SourceMap byte position. The position one past the end of the file is considered to be contained by the file. This implies that files for which is_empty returns true still contain one byte position according to this function.

pub fn is_empty(&self) -> bool

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

Calculates the original byte position relative to the start of the file based on the given byte position.

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

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

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

Looks up the file’s (1-based) line number and (0-based CharPos) column offset, for a given BytePos.

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

Looks up the file’s (1-based) line number, (0-based CharPos) column offset, and (0-based) column offset when displayed, for a given BytePos.

Trait Implementations

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceFile

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D: Decoder> Decodable<D> for SourceFile

fn decode(d: &mut D) -> Result<SourceFile, D::Error>

impl<S: Encoder> Encodable<S> for SourceFile

fn encode(&self, s: &mut S) -> Result<(), S::Error>