Struct SourceFiles 

pub struct SourceFiles { /* private fields */ }

A file database that can store multiple source files.

This is taking as is from codespan_reporting::files::SimpleFiles with the added ability to iterate over the files

There are a few TODOs on this structure that may or may not be needed:

• Use a custom SourceFile structure instead of SimpleFile
• Use a deterministic FileId instead of using usize

Implementations

impl SourceFiles

pub fn new() -> SourceFiles

Create a new files database.

pub fn add_file(&mut self, file: SourceFile) -> SourceFileId

Add a file to the database, returning the handle that can be used to refer to it again.

pub fn get( &self, file_id: SourceFileId, ) -> Result<&SimpleFile<String, String>, FilesError>

Get the file corresponding to the given id.

pub fn iter(&self) -> impl Iterator<Item = (SourceFileId, &SourceFile)> + '_

Trait Implementations

impl Default for SourceFiles

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Files<'a> for SourceFiles

type FileId = SourceFileId

A unique identifier for files in the file provider. This will be used for rendering diagnostic::Labels in the corresponding source files.

type Name = String

The user-facing name of a file, to be displayed in diagnostics.

type Source = &'a String

The source code of a file.

fn name(&self, file_id: Self::FileId) -> Result<String, FilesError>

The user-facing name of a file.

fn source(&self, file_id: Self::FileId) -> Result<&String, FilesError>

The source code of a file.

fn line_index( &self, file_id: Self::FileId, byte_index: usize, ) -> Result<usize, FilesError>

The index of the line at the given byte index. If the byte index is past the end of the file, returns the maximum line index in the file. This means that this function only fails if the file is not present.

fn line_range( &self, file_id: Self::FileId, line_index: usize, ) -> Result<Range<usize>, FilesError>

The byte range of line in the source of the file.

fn line_number( &'a self, id: Self::FileId, line_index: usize, ) -> Result<usize, Error>

The user-facing line number at the given line index. It is not necessarily checked that the specified line index is actually in the file.

fn column_number( &'a self, id: Self::FileId, line_index: usize, byte_index: usize, ) -> Result<usize, Error>

The user-facing column number at the given line index and byte index.

fn location( &'a self, id: Self::FileId, byte_index: usize, ) -> Result<Location, Error>

Convenience method for returning line and column number at the given byte index in the file.