Struct SourceFile

#[repr(C)]
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: Lrc<String>,
    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: Lrc<String>

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: String, start_pos: BytePos, ) -> SourceFile

pub fn new_from( name: Lrc<FileName>, name_was_remapped: bool, unmapped_path: Lrc<FileName>, src: Lrc<String>, 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 Archive for SourceFile

where Lrc<FileName>: Archive, bool: Archive, Option<Lrc<FileName>>: Archive, u32: Archive, EncodeArcString: ArchiveWith<Lrc<String>>, u128: Archive, BytePos: Archive, CacheCell<SourceFileAnalysis>: Archive,

type Archived = ArchivedSourceFile

The archived representation of this type.

type Resolver = SourceFileResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl<__C: Fallible + ?Sized> CheckBytes<__C> for SourceFile

where <__C as Fallible>::Error: Trace, Lrc<FileName>: CheckBytes<__C>, bool: CheckBytes<__C>, Option<Lrc<FileName>>: CheckBytes<__C>, u32: CheckBytes<__C>, Lrc<String>: CheckBytes<__C>, u128: CheckBytes<__C>, BytePos: CheckBytes<__C>, CacheCell<SourceFileAnalysis>: CheckBytes<__C>,

unsafe fn check_bytes( value: *const Self, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

Checks whether the given pointer points to a valid value within the given context.

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a copy 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<__D: Fallible + ?Sized> Deserialize<SourceFile, __D> for Archived<SourceFile>

where Lrc<FileName>: Archive, <Lrc<FileName> as Archive>::Archived: Deserialize<Lrc<FileName>, __D>, bool: Archive, <bool as Archive>::Archived: Deserialize<bool, __D>, Option<Lrc<FileName>>: Archive, <Option<Lrc<FileName>> as Archive>::Archived: Deserialize<Option<Lrc<FileName>>, __D>, u32: Archive, <u32 as Archive>::Archived: Deserialize<u32, __D>, EncodeArcString: ArchiveWith<Lrc<String>> + DeserializeWith<<EncodeArcString as ArchiveWith<Lrc<String>>>::Archived, Lrc<String>, __D>, u128: Archive, <u128 as Archive>::Archived: Deserialize<u128, __D>, BytePos: Archive, <BytePos as Archive>::Archived: Deserialize<BytePos, __D>, CacheCell<SourceFileAnalysis>: Archive, <CacheCell<SourceFileAnalysis> as Archive>::Archived: Deserialize<CacheCell<SourceFileAnalysis>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<SourceFile, <__D as Fallible>::Error>

Deserializes using the given deserializer

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.

impl<__S: Fallible + ?Sized> Serialize<__S> for SourceFile

where Lrc<FileName>: Serialize<__S>, bool: Serialize<__S>, Option<Lrc<FileName>>: Serialize<__S>, u32: Serialize<__S>, EncodeArcString: SerializeWith<Lrc<String>, __S>, u128: Serialize<__S>, BytePos: Serialize<__S>, CacheCell<SourceFileAnalysis>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.