Struct SourceFile 

pub struct SourceFile { /* private fields */ }

The representation of a source file in the database.

Implementations

impl SourceFile

pub fn name(&self) -> &FileName

Returns the FileName associated with this SourceFile

pub fn id(&self) -> SourceId

Returns the SourceId associated with this SourceFile

pub fn parent(&self) -> Option<SourceSpan>

Returns the parent SourceSpan for this SourceFile

pub fn line_start(&self, line_index: LineIndex) -> Result<ByteIndex, Error>

Computes the ByteIndex at which the line corresponding to line_index begins

pub fn last_line_index(&self) -> LineIndex

Returns the LineIndex of the last line in this file

pub fn location<I: Into<ByteIndex>>( &self, byte_index: I, ) -> Result<Location, Error>

Returns a Location corresponding to the given byte index in this file.

pub fn source(&self) -> &str

Returns the underlying content of this file as a string slice

pub fn source_span(&self) -> SourceSpan

Returns a SourceSpan covering all of the content in this file

pub fn source_slice(&self, span: impl Into<Range<usize>>) -> Result<&str, Error>

Returns a subset of the underlying content of this file as a string slice

The given range corresponds to character indices in the underlying content.

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.