pub struct TextStorage { /* private fields */ }
Implementations§
Source§impl TextStorage
impl TextStorage
Sourcepub fn file<P>(&mut self, file_path: P) -> Result<FileID, DiagnosticError>
pub fn file<P>(&mut self, file_path: P) -> Result<FileID, DiagnosticError>
Add a file to the database, returning the handle that can be used to refer to it again.
pub fn anonymous(&mut self, file_text: impl Display) -> FileID
pub fn update(&mut self, name: &FileID) -> Result<(), DiagnosticError>
Sourcepub fn get_cache(&self, file_id: &FileID) -> Result<&TextCache, DiagnosticError>
pub fn get_cache(&self, file_id: &FileID) -> Result<&TextCache, DiagnosticError>
Get the file corresponding to the given id.
Sourcepub fn get_text(&self, file_id: &FileID) -> Result<&str, DiagnosticError>
pub fn get_text(&self, file_id: &FileID) -> Result<&str, DiagnosticError>
The source code of a file.
Sourcepub fn line_index(
&self,
file_id: &FileID,
byte_index: usize,
) -> Result<usize, DiagnosticError>
pub fn line_index( &self, file_id: &FileID, byte_index: usize, ) -> Result<usize, DiagnosticError>
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.
§Note for trait implementors
This can be implemented efficiently by performing a binary search over
a list of line starts that was computed by calling the line_starts
function that is exported from the errors
module. It might be useful
to pre-compute and cache these line starts.
Sourcepub fn line_number(
&self,
file_id: &FileID,
line_index: usize,
) -> Result<usize, DiagnosticError>
pub fn line_number( &self, file_id: &FileID, line_index: usize, ) -> Result<usize, DiagnosticError>
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.
§Note for trait implementors
This is usually 1-indexed from the beginning of the file, but
can be useful for implementing something like the
C preprocessor’s #line
macro.
Sourcepub fn column_number(
&self,
file_id: &FileID,
line_index: usize,
byte_index: usize,
) -> Result<usize, DiagnosticError>
pub fn column_number( &self, file_id: &FileID, line_index: usize, byte_index: usize, ) -> Result<usize, DiagnosticError>
The user-facing column number at the given line index and byte index.
§Note for trait implementors
This is usually 1-indexed from the the start of the line.
A default implementation is provided, based on the column_index
function that is exported from the errors
module.
Sourcepub fn location(
&self,
file_id: &FileID,
byte_index: usize,
) -> Result<Location, DiagnosticError>
pub fn location( &self, file_id: &FileID, byte_index: usize, ) -> Result<Location, DiagnosticError>
Convenience method for returning line and column number at the given byte index in the file.
Sourcepub fn line_range(
&self,
file_id: &FileID,
line_index: usize,
) -> Result<Range<usize>, DiagnosticError>
pub fn line_range( &self, file_id: &FileID, line_index: usize, ) -> Result<Range<usize>, DiagnosticError>
The byte range of line in the source of the file.
Trait Implementations§
Source§impl Clone for TextStorage
impl Clone for TextStorage
Source§fn clone(&self) -> TextStorage
fn clone(&self) -> TextStorage
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more