Struct SourceFile 

pub struct SourceFile { /* private fields */ }

A file’s contents along with its display name

This is used for reporting rustc-style diagnostics where we show where in the file we found a problem. It contains an Arc so that it’s ~free for everything to pass/copy these around and produce better diagnostics.

Implementations

impl SourceFile

pub fn new_empty(origin_path: &str) -> Self

Create an empty SourceFile with the given name.

See SourceFile::new for details.

pub fn new(origin_path: &str, contents: String) -> Self

Create a new source file with the given name and contents.

This is intended for situations where you have the contents already and just want a SourceFile to manage it. This is appropriate for strings that were constructed dynamically or for tests.

The origin_path will be used as the filename as well.

pub fn load_local(origin_path: impl AsRef<Utf8Path>) -> Result<SourceFile>

SourceFile equivalent of LocalAsset::load_asset

pub fn filename(&self) -> &str

Get the filename of a SourceFile

pub fn origin_path(&self) -> &str

Get the origin_path of a SourceFile

pub fn as_str(&self) -> &str

Get the contents of a SourceFile

pub fn contents(&self) -> &str

Get the contents of a SourceFile (alias for as_str)

pub fn span_for_line_col(&self, line: usize, col: usize) -> Option<SourceSpan>

Gets a proper SourceSpan from a line-and-column representation

Both values are 1’s based, so (1, 1) is the start of the file. If anything underflows/overflows or goes out of bounds then we’ll just return None. unwrap_or_default() will give you the empty span from that.

This is a pretty heavy-weight process, we have to basically linearly scan the source for this position!

pub fn span_for_substr(&self, substr: &str) -> Option<SourceSpan>

Creates a span for an item using a substring of contents

Note that substr must be a literal substring, as in it must be a pointer into the same string! If it’s not we’ll return None.

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

fn read_span<'a>( &'a self, span: &SourceSpan, context_lines_before: usize, context_lines_after: usize, ) -> Result<Box<dyn SpanContents<'a> + 'a>, MietteError>

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.

impl Eq for SourceFile

impl StructuralPartialEq for SourceFile