Struct SourceFile 

pub struct SourceFile {
    pub contents: String,
    /* private fields */
}

A concatenated string of files, with sourcemap information.

Fields

contents: String

The full contents of all the files

Implementations

impl SourceFile

pub fn new() -> Self

Create a new empty sourcefile. Equivalent to Default::default.

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

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 calculation.

pub fn add_file_raw(&mut self, name: impl Display, contents: impl Into<String>)

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

Formats the value using the given formatter.

impl Default for SourceFile

fn default() -> SourceFile

Returns the “default value” for a type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for SourceFile

impl StructuralPartialEq for SourceFile