Struct codespan_reporting::files::SimpleFiles

pub struct SimpleFiles<Name, Source> { /* private fields */ }

A file database that can store multiple source files.

This is useful for simple language tests, but it might be worth creating a custom implementation when a language scales beyond a certain size. It is a glorified Vec<SimpleFile> that implements the Files trait.

Implementations

impl<Name, Source> SimpleFiles<Name, Source> where
    Name: Display,
    Source: AsRef<str>, 

pub fn new() -> SimpleFiles<Name, Source>

Create a new files database.

pub fn add(&mut self, name: Name, source: Source) -> usize

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

pub fn get(&self, file_id: usize) -> Result<&SimpleFile<Name, Source>, Error>

Get the file corresponding to the given id.

Trait Implementations

impl<Name: Clone, Source: Clone> Clone for SimpleFiles<Name, Source>

fn clone(&self) -> SimpleFiles<Name, Source>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Name: Debug, Source: Debug> Debug for SimpleFiles<Name, Source>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Name, Source> Files<'a> for SimpleFiles<Name, Source> where
    Name: 'a + Display + Clone,
    Source: 'a + AsRef<str>, 

type FileId = usize

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

type Name = Name

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

type Source = &'a str

The source code of a file.

fn name(&self, file_id: usize) -> Result<Name, Error>

The user-facing name of a file.

fn source(&self, file_id: usize) -> Result<&str, Error>

The source code of a file.

fn line_index(&self, file_id: usize, byte_index: usize) -> Result<usize, Error>

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: usize,
    line_index: usize
) -> Result<Range<usize>, Error>

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.