Struct SourceFile 

pub struct SourceFile {
    pub name: Lrc<FileName>,
    pub name_was_remapped: bool,
    pub unmapped_path: Option<Lrc<FileName>>,
    pub crate_of_origin: u32,
    pub src: BytesStr,
    pub src_hash: u128,
    pub start_pos: BytePos,
    pub end_pos: BytePos,
    pub name_hash: u128,
    /* private fields */
}

A single source in the SourceMap.

Fields

name: Lrc<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<Lrc<FileName>>

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

crate_of_origin: u32

Indicates which crate this SourceFile was imported from.

src: BytesStr

The complete source code

src_hash: u128

The source code’s hash

start_pos: BytePos

The start position of this source in the SourceMap

end_pos: BytePos

The end position of this source in the SourceMap

name_hash: u128

A hash of the filename, used for speeding up the incr. comp. hashing.

Implementations

impl SourceFile

pub fn new( name: Lrc<FileName>, name_was_remapped: bool, unmapped_path: Lrc<FileName>, src: BytesStr, start_pos: BytePos, ) -> SourceFile

src should not have UTF8 BOM

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

Return the BytePos of the beginning of the current line.

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

Get 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 byte_length(&self) -> u32

pub fn count_lines(&self) -> usize

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

Find 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) -> (BytePos, BytePos)

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

pub fn analyze(&self) -> &SourceFileAnalysis

Trait Implementations

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a duplicate 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<'a> From<&'a SourceFile> for StringInput<'a>

Creates an Input from SourceFile. This is an alias for

   StringInput::new(&fm.src, fm.start_pos, fm.end_pos)

fn from(fm: &'a SourceFile) -> Self

Converts to this type from the input type.

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