Struct File

pub struct File {
    pub source: String,
    pub name: String,
    pub path: Option<PathBuf>,
    pub id: usize,
    pub kind: FileKind,
    pub line_starts: Vec<usize>,
}

A structure representing either a concrete (in-disk) or virtual (temporary/non-disk) js, ts, or mjs file.

Fields

source: String

name: String

The name of the file.

path: Option<PathBuf>

The path in disk if this is a concrete file.

id: usize

The rslint_errors id assigned to this file used to refer back to it.

kind: FileKind

The kind of file this is.

line_starts: Vec<usize>

The cached line start locations in this file.

Implementations

impl File

pub fn new_concrete(source: String, path: PathBuf) -> Self

pub fn from_string( source: impl ToString, kind: FileKind, name: impl ToString, ) -> Self

pub fn update_src(&mut self, new: String)

pub fn line_starts(source: &str) -> impl Iterator<Item = usize> + '_

pub fn line_start(&self, line_index: usize) -> Option<usize>

pub fn line_index(&self, byte_index: usize) -> usize

pub fn line_col_to_index(&self, line: usize, column: usize) -> Option<usize>

pub fn line_range(&self, line_index: usize) -> Option<Range<usize>>

pub fn parse(&self) -> SyntaxNode

Parse this file into a syntax node, ignoring any errors produced. This

pub fn parse_with_errors(&self) -> (Vec<ParserError>, SyntaxNode)

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for File

impl StructuralPartialEq for File