Struct SourceFile 

pub struct SourceFile(/* private fields */);

SourceFile represents a source into which spans point. Source files can be cheaply cloned as the actual contents of them live behind an Rc.

Implementations

impl SourceFile

pub fn open(name: impl AsRef<Path>) -> Result<Self>

pub fn new(contents: impl AsRef<str>, name: impl AsRef<str>) -> Self

Create a new SourceFile

pub fn new_for_test(s: impl AsRef<str>) -> Self

pub fn iter(&self) -> SourceFileIterator<'_>

pub fn name(&self) -> &str

returns the name of this source file

pub fn contents(&self) -> &str

returns the contents of this source file as a string. When parsing you likely often want to use .iter() instead as the source file iterator has a number of methods useful for parsing.

pub fn contents_for_display(&self) -> &str

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<'de> Deserialize<'de> for SourceFile

fn deserialize<D>(_deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SourceFile

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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.