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 stable_id: StableSourceFileId,
    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.

§stable_id: StableSourceFileId

A hash of the filename & crate-id, used for uniquely identifying source files within the crate graph and for speeding up hashing in incremental compilation.

§cnum: CrateNum

Indicates which crate this SourceFile was imported from.

Implementations§

source§

impl SourceFile

source

pub fn new( name: FileName, src: String, hash_kind: SourceFileHashAlgorithm, ) -> Result<Self, OffsetOverflowError>

source

pub(crate) fn convert_diffs_to_lines_frozen(&self)

This converts the lines field to contain SourceFileLines::Lines if needed and freezes it.

source

pub fn lines(&self) -> &[RelativeBytePos]

source

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

Returns the BytePos of the beginning of the current line.

source

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.

source

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.

source

pub fn is_real_file(&self) -> bool

source

pub fn is_imported(&self) -> bool

source

pub fn count_lines(&self) -> usize

source

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

source

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

source

pub fn end_position(&self) -> BytePos

source

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.

source

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

source

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.

source

pub fn is_empty(&self) -> bool

source

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.

source

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.

source

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

Converts an relative RelativeBytePos to a CharPos relative to the SourceFile.

source

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.

source

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§

source§

impl Clone for SourceFile

source§

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
source§

impl Debug for SourceFile

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

source§

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

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: 288 bytes