Struct codemap::File

pub struct File {
    pub span: Span,
    // some fields omitted
}

A CodeMap's record of a source file.

Fields

span: Span

The span representing the entire file.

Methods

impl File

pub fn name(&self) -> &str

Gets the name of the file

pub fn find_line(&self, pos: Pos) -> usize

Gets the line number of a Pos.

The lines are 0-indexed (first line is numbered 0)

Panics

• If pos is not within this file's span

pub fn find_line_col(&self, pos: Pos) -> LineCol

Gets the line and column of a Pos.

Panics

• If pos is not with this file's span
• If pos points to a byte in the middle of a UTF-8 character

pub fn source(&self) -> &str

Gets the full source text of the file

pub fn source_slice(&self, span: Span) -> &str

Gets the source text of a Span.

Panics

• If span is not entirely within this file.

pub fn line_span(&self, line: usize) -> Span

Gets the span representing a line by line number.

The line number is 0-indexed (first line is numbered 0). The returned span includes the line terminator.

Panics

• If the line number is out of range

pub fn source_line(&self, line: usize) -> &str

Gets the source text of a line.

The string returned does not include the terminating \r or \n characters.

Panics

• If the line number is out of range

pub fn num_lines(&self) -> usize

Gets the number of lines in the file

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Eq for File

impl Hash for File

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<File> for File

fn eq(&self, other: &File) -> bool

Compares by identity

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.