Struct SourceManager

pub struct SourceManager { /* private fields */ }

A manager for sources, which stores sources and provides methods to insert and retrieve them.

Implementations

impl SourceManager

pub fn new(interner: ThreadedInterner) -> Self

Creates a new source manager with the given interner.

Parameters

• interner: The interner to use for source names.

Returns

The new source manager.

pub fn insert_path( &self, name: String, path: PathBuf, user_defined: bool, ) -> SourceIdentifier

Inserts a source with the given name and path into the manager.

Parameters

• name: The name of the source.
• path: The path to the source.
• user_defined: Whether the source is user-defined.

Returns

The identifier of the inserted source.

pub fn insert_content( &mut self, name: String, content: String, user_defined: bool, ) -> SourceIdentifier

Inserts a source with the given name and content into the manager.

Parameters

• name: The name of the source.
• content: The content of the source.
• user_defined: Whether the source is user-defined.

Returns

The identifier of the inserted source.

pub fn contains(&self, source_id: &SourceIdentifier) -> bool

Checks whether the manager contains a source with the given identifier.

Parameters

• source_id: The identifier of the source to check for.

Returns

Whether the manager contains a source with the given identifier.

pub fn source_ids(&self) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all source identifiers in the manager.

pub fn user_defined_source_ids( &self, ) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all user-defined source identifiers in the manager.

pub fn external_source_ids(&self) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all external source identifiers in the manager.

pub fn load(&self, source_id: SourceIdentifier) -> Result<Source, SourceError>

Retrieve the source with the given identifier from the manager.

Parameters

• source_id: The identifier of the source to retrieve.

Returns

The source with the given identifier, or an error if the source does not exist, or could not be loaded.

pub fn write( &self, source_id: SourceIdentifier, content: String, ) -> Result<(), SourceError>

pub fn len(&self) -> usize

Retrieve the number of sources in the manager.

pub fn is_empty(&self) -> bool

Check whether the manager is empty.

Trait Implementations

impl Clone for SourceManager

fn clone(&self) -> SourceManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceManager

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

Formats the value using the given formatter.

impl<'a> Files<'a> for SourceManager

type FileId = SourceIdentifier

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

type Name = &'a str

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

type Source = &'a str

The source code of a file.

fn name(&'a self, file_id: SourceIdentifier) -> Result<&'a str, Error>

The user-facing name of a file.

fn source(&'a self, file_id: SourceIdentifier) -> Result<&'a str, Error>

The source code of a file.

fn line_index( &self, file_id: SourceIdentifier, 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: SourceIdentifier, 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.

impl Send for SourceManager

impl Sync for SourceManager