Trait World

pub trait World {
    // Required methods
    fn entry_point(&self) -> FileId;
    fn source(&self, file_id: FileId) -> FileResult<Source>;
    fn library(&self) -> &Library;
    fn write(&self, f: &dyn Fn(&mut dyn Write) -> Result<()>) -> Result<()>;
    fn read(&self, f: &dyn Fn(&mut dyn Read) -> Result<()>) -> Result<()>;

    // Provided methods
    fn name(&self, id: FileId) -> String { ... }
    fn related_source(&self, span: Span) -> Option<Source> { ... }
}

Required Methods

fn entry_point(&self) -> FileId

The entrypoint file of the program to execute

fn source(&self, file_id: FileId) -> FileResult<Source>

fn library(&self) -> &Library

fn write(&self, f: &dyn Fn(&mut dyn Write) -> Result<()>) -> Result<()>

fn read(&self, f: &dyn Fn(&mut dyn Read) -> Result<()>) -> Result<()>

Provided Methods

fn name(&self, id: FileId) -> String

fn related_source(&self, span: Span) -> Option<Source>

Trait Implementations

impl<'a> Files<'a> for &dyn World

type FileId = FileId

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 = Source

The source code of a file.

fn name(&'a self, id: Self::FileId) -> Result<Self::Name, Error>

The user-facing name of a file.

fn source(&'a self, id: Self::FileId) -> Result<Self::Source, Error>

The source code of a file.

fn line_index( &'a self, id: Self::FileId, 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( &'a self, id: Self::FileId, 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.

Implementors