Struct rustc_span::SourceFile

source ·
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: Lock<SourceFileLines>,
    pub multibyte_chars: Vec<MultiByteChar>,
    pub non_narrow_chars: Vec<NonNarrowChar>,
    pub normalized_pos: Vec<NormalizedPos>,
    pub name_hash: Hash128,
    pub cnum: CrateNum,
Expand description

A single source in the SourceMap.


§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: Lock<SourceFileLines>

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: Hash128

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

§cnum: CrateNum

Indicates which crate this SourceFile was imported from.



impl SourceFile


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


pub fn lines<F, R>(&self, f: F) -> Rwhere F: FnOnce(&[BytePos]) -> R,


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) -> boolwhere 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 normalized_byte_pos(&self, offset: u32) -> BytePos

Calculates a normalized byte position from a byte offset relative to the start of the file.

When we get an inline assembler error from LLVM during codegen, we import the expanded assembly code as a new SourceFile, which can then be used for error reporting with spans. However the byte offsets given to us by LLVM are relative to the start of the original buffer, not the normalized one. Hence we need to convert those offsets to the normalized form when constructing spans.


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) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for SourceFile


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

Formats the value using the given formatter. Read more

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


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


fn encode(&self, s: &mut S)

Auto Trait Implementations§

Blanket Implementations§


impl<T> Any for Twhere T: 'static + ?Sized,


fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,


fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,


fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T


fn from(t: T) -> T

Returns the argument unchanged.


impl<T, U> Into<U> for Twhere U: From<T>,


fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.


impl<T> ToOwned for Twhere T: Clone,


type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere U: Into<T>,


type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,


type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.


Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size:288 bytes