codespan_reporting::files

Struct SimpleFiles

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

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§

Source§

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

Source

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

Create a new files database.

Source

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.

Source

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

Get the file corresponding to the given id.

Trait Implementations§

Source§

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

Source§

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

Returns a copy 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<Name: Debug, Source: Debug> Debug for SimpleFiles<Name, Source>

Source§

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

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

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

Source§

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.
Source§

type Name = Name

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

type Source = &'a str

The source code of a file.
Source§

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

The user-facing name of a file.
Source§

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

The source code of a file.
Source§

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. Read more
Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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.

Auto Trait Implementations§

§

impl<Name, Source> Freeze for SimpleFiles<Name, Source>

§

impl<Name, Source> RefUnwindSafe for SimpleFiles<Name, Source>
where Name: RefUnwindSafe, Source: RefUnwindSafe,

§

impl<Name, Source> Send for SimpleFiles<Name, Source>
where Name: Send, Source: Send,

§

impl<Name, Source> Sync for SimpleFiles<Name, Source>
where Name: Sync, Source: Sync,

§

impl<Name, Source> Unpin for SimpleFiles<Name, Source>
where Name: Unpin, Source: Unpin,

§

impl<Name, Source> UnwindSafe for SimpleFiles<Name, Source>
where Name: UnwindSafe, Source: UnwindSafe,

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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.