Struct FileProjection 

pub struct FileProjection { /* private fields */ }

A utility struct for holding a set of paths, and all children from those paths. Contains an associated set of “exclude” paths whose children should not be returned.

Implementations

impl FileProjection

pub fn new( src_paths: impl IntoIterator<Item = impl AsRef<Path>>, excl_paths: impl IntoIterator<Item = impl AsRef<Path>>, excl_exts: impl IntoIterator<Item = impl AsRef<OsStr>>, ) -> Result<Self, FileProjectionError>

Create a new FileProjection with the given src_paths, excl_paths and ignore-extensions Child files can either be got by projecting the src_paths, either from the filesystem (project_using_fs), or from some list (project_using_list). Once projection has occurred the projected files will be cached by this struct (This feature is mostly to avoid having to visit the filesystem more than once when performing large projections)

Projected files can be retrieved by calling projected_files

pub fn contains(&self, src_path: impl AsRef<Path>) -> bool

Returns true if the given path is a child of any src_path, and is not a child of any excl_path.

pub fn project_using_fs(&mut self) -> Result<Vec<Error>, FileProjectionError>

Visit the filesystem to get all child files which are a child of any of Self::src_paths, and which are not a child of Self::excl_paths.

Return values

Returns Err() if any path in Self::src_paths or Self::excl_paths cannot be read from the filesystem.

Otherwise returns Ok() containing a list of all other errors encountered while retrieving paths from the filesystem.

Panics

This function will panic if either project_using_fs or project_using_list has already been called.

pub fn project_using_list( &mut self, list: impl IntoIterator<Item = impl AsRef<Path>>, )

Enumerate files by filtering a list of paths.

Panics

This function will panic if either project_using_fs or project_using_list has already been called.

pub fn projected_files(&self) -> &HashSet<PathBuf>

Obtain the set of all enumerated files. File enumeration must have already taken place.

Panics

This function will panic if enumeration has not occurred.

Trait Implementations

impl Clone for FileProjection

fn clone(&self) -> FileProjection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileProjection

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

Formats the value using the given formatter.