Struct ParsedFile

pub struct ParsedFile<'a> { /* private fields */ }

The result of finding function with a given name. Use Self::search_file or Self::search_file_with_name to do the searching.

Implementations

impl<'a> ParsedFile<'a>

pub fn new( file: &'a str, function_name: &'a str, language_type: &'a str, tree: Tree, results: Box<[Range]>, ) -> Self

pub fn filter(&self, f: fn(&Node<'_>) -> bool) -> Result<Self, Error>

Filters out commits not matching the filter [f]. Returns new version of the current ParsedFile with only the results that match the filter.

Errors

If the filter [f] filters out all the results of this file

pub const fn language(&self) -> &str

Get the name of the language used to parse this file

pub const fn search_name(&self) -> &str

Get the name of the function that was searched for to make this ParsedFile

pub fn search_file( name: &'a str, code: &'a str, language: &'a dyn SupportedLanguage, ) -> Result<Self, Error>

Search for all function with the name [name], in string [code] with the specified language [language].

Note: to obtain the the language you may use get_file_type_from_file or get_file_type_from_file_ext. Alternativly use Self::search_file_with_name to let us find the correct language for you.

Errors

If something with tree sitter goes wrong. If the code cannot be parsed properly. If no results are found for this function name.

pub fn search_file_with_name( name: &'a str, code: &'a str, file_name: &'a str, langs: &'a [&'a dyn SupportedLanguage], ) -> Result<Self, Error>

Search for all function with the name [name], in string [code] with a language found from the file name [file_name] and the languages [langs].

Errors

If there is no language found for the given file name. If something with tree sitter goes wrong. If the code cannot be parsed properly, If no results are found for this function name.

pub const fn file_name(&self) -> Option<&str>

Get the file name of this file.

pub fn results(&self) -> &[Range]

Get the Range of each found function.

Trait Implementations

impl<'a> Clone for ParsedFile<'a>

fn clone(&self) -> ParsedFile<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParsedFile<'a>

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

Formats the value using the given formatter.

impl Display for ParsedFile<'_>

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

Formats the value using the given formatter.

impl IntoIterator for ParsedFile<'_>

type Item = (Range, String)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = <ParsedFile<'_> as IntoIterator>::Item>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.