Struct TextStorage

Source
pub struct TextStorage { /* private fields */ }

Implementations§

Source§

impl TextStorage

Source

pub fn file<P>(&mut self, file_path: P) -> Result<FileID, DiagnosticError>
where P: AsRef<Path>,

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

Source

pub fn anonymous(&mut self, file_text: impl Display) -> FileID

Source

pub fn update(&mut self, name: &FileID) -> Result<(), DiagnosticError>

Source

pub fn get_cache(&self, file_id: &FileID) -> Result<&TextCache, DiagnosticError>

Get the file corresponding to the given id.

Source

pub fn get_text(&self, file_id: &FileID) -> Result<&str, DiagnosticError>

The source code of a file.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Source§

fn clone(&self) -> TextStorage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextStorage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextStorage

Source§

fn default() -> TextStorage

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,