Struct SourceFile 

#[non_exhaustive]
pub struct SourceFile {
    pub name: FileName,
    pub src: Arc<String>,
    pub start_pos: BytePos,
    pub source_len: RelativeBytePos,
    pub lines: Vec<RelativeBytePos>,
    pub multibyte_chars: Vec<MultiByteChar>,
}

A single source in the SourceMap.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

src: Arc<String>

The complete source code.

start_pos: BytePos

The start position of this source in the SourceMap.

source_len: RelativeBytePos

The byte length of this source.

lines: Vec<RelativeBytePos>

Locations of lines beginnings in the source code.

multibyte_chars: Vec<MultiByteChar>

Locations of multi-byte characters in the source code.

Implementations

impl SourceFile

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

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

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_position(&self, line_number: usize) -> Option<usize>

Returns the relative byte position of the start of the line at the given 0-based line index.

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.

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

Gets a line from the list of pre-computed line-beginnings. The line number here is 0-based.

pub fn get_lines(&self, range: RangeInclusive<usize>) -> Option<&str>

Gets a slice of the source text between two lines, including the terminator of the second line (if any).

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

Calculates the original byte position relative to the start of the file based on the given byte position.

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, __derive_more_f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for SourceFile

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SourceFile

fn eq(&self, other: &SourceFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SourceFile