Struct rustc_span::SourceFile[][src]

pub struct SourceFile {
    pub name: FileName,
    pub name_was_remapped: bool,
    pub unmapped_path: Option<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.


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

name_was_remapped: bool

true if the name field above has been modified by --remap-path-prefix.

unmapped_path: Option<FileName>

The unmapped path of the file that the source came from. Set to None if the SourceFile was imported from an external crate.

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.


impl SourceFile[src]

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

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

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>>[src]

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[src]

pub fn is_imported(&self) -> bool[src]

pub fn byte_length(&self) -> u32[src]

pub fn count_lines(&self) -> usize[src]

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

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>[src]

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

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[src]

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

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[src]

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

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

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(
    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[src]

impl Debug for SourceFile[src]

impl<D: Decoder> Decodable<D> for SourceFile[src]

impl<S: Encoder> Encodable<S> for SourceFile[src]

Auto Trait Implementations

impl !RefUnwindSafe for SourceFile

impl !Send for SourceFile

impl !Sync for SourceFile

impl Unpin for SourceFile

impl UnwindSafe for SourceFile

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.