Struct FileFilter

pub struct FileFilter {
    pub ignored: Vec<String>,
    pub not_ignored: Vec<String>,
    pub extensions: Vec<String>,
}

Fields

ignored: Vec<String>

not_ignored: Vec<String>

extensions: Vec<String>

Implementations

impl FileFilter

pub fn new(ignore: &[String], extensions: Vec<String>) -> Self

pub fn parse_submodules(&mut self)

This function will also read a .gitmodules file located in the working directory. The named submodules’ paths will be automatically added to the ignored list, unless the submodule’s path is already specified in the not_ignored list.

pub fn is_file_in_list(&self, file_name: &Path, is_ignored: bool) -> bool

Describes if a specified file_name is contained within the specified set of paths.

The is_ignored flag describes which set of paths is used as domains. The specified file_name can be a direct or distant descendant of any paths in the set.

Returns a true value of the the path/pattern that matches the given file_name. If given file_name is not in the specified set, then false is returned.

pub fn is_source_or_ignored(&self, entry: &Path) -> bool

A helper function that checks if entry satisfies the following conditions (in ordered priority):

• Does entry’s path use at least 1 of the listed file extensions? (takes precedence)
• Is entry not specified in list of ignored paths?
• Is entry specified in the list of explicitly not_ignored paths? (supersedes specified ignored paths)

pub fn list_source_files(&self, root_path: &str) -> Result<Vec<FileObj>>

Walks a given root_path recursively and returns a Vec<FileObj> that

• uses at least 1 of the given extensions
• is not specified in the internal list of ignored paths
• is specified in the internal list not_ignored paths (which supersedes ignored paths)

Trait Implementations

impl Clone for FileFilter

fn clone(&self) -> FileFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileFilter

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

Formats the value using the given formatter.