Trait hotspots_parser::Parser

pub trait Parser {
    // Required methods
    fn container(&mut self) -> &mut Container;
    fn ro_container(&self) -> &Container;
    fn supported(&self, f: &File) -> bool;
    fn language(&self) -> Language;
    fn query(&self) -> &Query;

    // Provided methods
    fn add_file(&mut self, f: File) -> Result<(), Error> { ... }
    fn files(&self) -> Result<&[File], Error> { ... }
    fn filter_name(&mut self, s: String) { ... }
    fn filter(&self, p: &str) -> bool { ... }
    fn func_repr(&self, v: Vec<Element>) -> (Vec<Element>, usize) { ... }
    fn find_functions(
        &mut self,
        pb: &ProgressBar
    ) -> Result<Vec<Element>, Error> { ... }
}

Parser provides the functionalities necessary for finding tree-sitter Nodes from a list of given files.

Required Methods

fn container(&mut self) -> &mut Container

Returns a mutable reference to the container.

fn ro_container(&self) -> &Container

Returns a reference to the container.

fn supported(&self, f: &File) -> bool

Returns true if the file is compatible with the Parser.

fn language(&self) -> Language

Returns a tree-sitter language.

fn query(&self) -> &Query

Returns a tree-sitter Query object for the Parser’s language.

Provided Methods

fn add_file(&mut self, f: File) -> Result<(), Error>

Will return an error if the file is not compatible with the Parser.

fn files(&self) -> Result<&[File], Error>

Returns a mutable reference to the given files. It returns and error if the file can’t be read.

fn filter_name(&mut self, s: String)

Adds the filter for excluding functions.

fn filter(&self, p: &str) -> bool

Applies the filter on function names.

fn func_repr(&self, v: Vec<Element>) -> (Vec<Element>, usize)

Returns a new vector with the representation names for functions.

fn find_functions(&mut self, pb: &ProgressBar) -> Result<Vec<Element>, Error>

Returns all the functions in all files. It returns and error if the file can’t be read, or the language parser can’t parse the contents.

Implementors

impl Parser for GoParser

impl Parser for LuaParser

impl Parser for RustParser