Struct rustc_span::SourceFile
source · pub struct SourceFile {
pub name: FileName,
pub src: Option<Lrc<String>>,
pub src_hash: SourceFileHash,
pub external_src: FreezeLock<ExternalSource>,
pub start_pos: BytePos,
pub source_len: RelativeBytePos,
pub lines: FreezeLock<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
.
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: FreezeLock<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
.
source_len: RelativeBytePos
The byte length of this source.
lines: FreezeLock<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.
Implementations§
source§impl SourceFile
impl SourceFile
pub fn new( name: FileName, src: String, hash_kind: SourceFileHashAlgorithm ) -> Result<Self, OffsetOverflowError>
sourcepub(crate) fn convert_diffs_to_lines_frozen(&self)
pub(crate) fn convert_diffs_to_lines_frozen(&self)
This converts the lines
field to contain SourceFileLines::Lines
if needed and freezes it.
pub fn lines(&self) -> &[RelativeBytePos]
sourcepub fn line_begin_pos(&self, pos: BytePos) -> BytePos
pub fn line_begin_pos(&self, pos: BytePos) -> BytePos
Returns the BytePos
of the beginning of the current line.
sourcepub fn add_external_src<F>(&self, get_src: F) -> boolwhere
F: FnOnce() -> Option<String>,
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.
sourcepub fn get_line(&self, line_number: usize) -> Option<Cow<'_, str>>
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 absolute_position(&self, pos: RelativeBytePos) -> BytePos
pub fn relative_position(&self, pos: BytePos) -> RelativeBytePos
pub fn end_position(&self) -> BytePos
sourcepub fn lookup_line(&self, pos: RelativeBytePos) -> Option<usize>
pub fn lookup_line(&self, pos: RelativeBytePos) -> 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>
sourcepub fn contains(&self, byte_pos: BytePos) -> bool
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
sourcepub fn original_relative_byte_pos(&self, pos: BytePos) -> RelativeBytePos
pub fn original_relative_byte_pos(&self, pos: BytePos) -> RelativeBytePos
Calculates the original byte position relative to the start of the file based on the given byte position.
sourcepub fn normalized_byte_pos(&self, offset: u32) -> BytePos
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.
sourcepub(crate) fn bytepos_to_file_charpos(&self, bpos: RelativeBytePos) -> CharPos
pub(crate) fn bytepos_to_file_charpos(&self, bpos: RelativeBytePos) -> CharPos
Converts an relative RelativeBytePos
to a CharPos
relative to the SourceFile
.
sourcepub(crate) fn lookup_file_pos(&self, pos: RelativeBytePos) -> (usize, CharPos)
pub(crate) fn lookup_file_pos(&self, pos: RelativeBytePos) -> (usize, CharPos)
Looks up the file’s (1-based) line number and (0-based CharPos
) column offset, for a
given RelativeBytePos
.
Trait Implementations§
source§impl Clone for SourceFile
impl Clone for SourceFile
source§impl Debug for SourceFile
impl Debug for SourceFile
source§impl<D: Decoder> Decodable<D> for SourceFile
impl<D: Decoder> Decodable<D> for SourceFile
fn decode(d: &mut D) -> SourceFile
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Layout§
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: 304 bytes