Struct sourcefile::SourceFile

pub struct SourceFile {
    pub contents: String,
    // some fields omitted
}

A concatenated string of files, with sourcemap information.

Fields

contents: String

The full contents of all the files

Methods

impl SourceFile

pub fn add_file(     self,     filename: impl AsRef<Path> ) -> Result<Self, Error>

Concatenate a file to the end of contents, and record info needed to resolve spans.

If the last line doesn't end with a newline character, it will still be a 'line' for the purposes of this calcuation.

Consumes self because the structure would be inconsistent after an error.

pub fn resolve_offset<'a>(&'a self, offset: usize) -> Option<Position<'a>>

Get the file, line, and col position of a byte offset.

Panics

This function will panic if offset is not on a character boundary.

pub fn resolve_offset_span<'a>(     &'a self,     start: usize,     end: usize ) -> Option<Span<'a>>

Get the file, line, and col position of each end of a span

Trait Implementations

impl Default for SourceFile

fn default() -> SourceFile

Returns the "default value" for a type.

impl Debug for SourceFile

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

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 Eq for SourceFile

impl PartialEq for SourceFile

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for SourceFile

fn cmp(&self, other: &SourceFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for SourceFile

fn partial_cmp(&self, other: &SourceFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for SourceFile

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].