RustDirNav Repository

DFS visitation of directory

Quick Status

version

1.1.0

Code functions correctly

No known defects

Demonstration code

yes

Documentation

yes

Test cases

coming soon

Static library

yes

Build requires

Rust installation

Planned design changes

None at this time

Fig 1. Directory Navigator Types

Fig 1. Directory Navigator Output

Concept:

RustDirNav is a facility for Depth-First-Search (DFS) of specified directory tree. It uses a generic parameter to provide application specific do_dir and do_file operations.

Design:

There is one struct, DirNav<App>, with methods and functions implementing this design: Methods:

new() -> Self
Create new DirNav which has visit method for recursive DFS.
add_pat(&mut self, s&str) -> Self
Add pattern to match file extension. Can be chained.
visit(&mut self, p:&Path)
Walks directory tree rooted at path p, looking for files matching pattern(s).
recurse(&mut self, p:bool)
Sets or resets option to recurse directory tree.
hide(&mut self, p:bool)
Sets or resets option to hide directories with no target contents.
get_app(&mut self) -> &mut app
Retrieves reference to embedded application, set with generic parameter.
get_dirs(&self) -> usize
Retrieves the number of directories entered
get_files(&self) -> usize
Retrieves the number of files processed.
get_patts(&self) -> &SearchPatterns
Retrieves vector of patterns.
clear(&self)
Returns DirNav<app> to its initial state.

The DirEvent trait constrains the App generic parameter to supply do_dir and do_file methods that define what the application will do when the navigator encounters a new directory or file.

pub trait DirEvent { fn do_dir(&mut self, d: &str); fn do_file(&mut self, f: &str); }

The DirNav package provides a demonstration of the library in its /examples/test1.rs file. For the demo, test1 simply displays each directory once, and all of the files in that directory. The App type is defined by implementing the DirEvent trait, which may contain data members.

The lib.rs file defines all of the DirNav processing and, in its tests section, defines an ApplTest type that implements DirEvent and contains a vector that will hold each of the files found during test, so we can verify its operation.

Operation:

See Test1.rs in examples folder for typical usage.

Build:

Download and, in a command prompt, cargo build or cargo run.

Status:

Version 1.1.0
Tested on both Windows 10 and Ubuntu Linux