Struct codespan_preprocessed::PreprocessedFile

pub struct PreprocessedFile<Source> { /* private fields */ }

The codemap of a preprocessed file.

Implementations

impl<Source> PreprocessedFile<Source> where
    Source: AsRef<str>, 

pub fn new(contents: Source) -> Self

pub fn source(&self) -> &str

pub fn len(&self) -> usize

impl PreprocessedFile<String>

pub fn open<P: AsRef<Path>>(filename: P) -> Result<Self, Error>

pub fn from_stdin() -> Result<Self, Error>

Trait Implementations

impl<Source: Debug> Debug for PreprocessedFile<Source>

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

Formats the value using the given formatter.

impl<'a, S: 'a + AsRef<str>> EasyLocation<'a> for PreprocessedFile<S>

fn file_id(&'a self, byte_index: usize) -> <Self as Files<'a>>::FileId

impl<'a, S: 'a + AsRef<str>> Files<'a> for PreprocessedFile<S>

type FileId = &'a FileSlice

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, id: Self::FileId) -> Result<Self::Name, Error>

The user-facing name of a file.

fn source(&'a self, _: 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.