Struct gluon_base::source::FileMap

pub struct FileMap { /* fields omitted */ }

Implementations

impl FileMap

pub fn new(name: String, source: String) -> Self

pub fn span(&self) -> Span<BytePos>

pub fn source(&self) -> &str

pub fn name(&self) -> &str

Trait Implementations

impl Debug for FileMap

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

Formats the value using the given formatter.

impl<'a> Files<'a> for FileMap

type FileId = ()

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

type Name = String

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

type Source = &'a str

The source code of a file.

fn name(&self, _file_id: Self::FileId) -> Result<Self::Name>

The user-facing name of a file.

fn source(&self, _file_id: Self::FileId) -> Result<&str>

The source code of a file.

fn line_index(&self, file_id: Self::FileId, byte_index: usize) -> Result<usize>

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: Self::FileId,
    line_index: usize
) -> Result<Range<usize>>

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 Source for FileMap

fn location(&self, byte: BytePos) -> Option<Location>

Returns the line and column location of byte

fn comment_start_before(&self, end: BytePos) -> BytePos

Returns the starting position of any comments and whitespace before end

fn new(s: &str) -> Self where
    Self: Sized, 

fn span(&self) -> Span<BytePos>

fn src(&self) -> &str

fn src_slice(&self, span: Span<BytePos>) -> &str

fn byte_index(&self, line: Line, column: Column) -> Option<BytePos>

fn line_number_at_byte(&self, pos: BytePos) -> Option<Line>

fn comments_between(&self, span: Span<BytePos>) -> CommentIter<'_>