# treewalk
Common utilities for exploring a file tree
## Example usage
```rust
use std::path::{Path, PathBuf};
use treewalk::walk::{comparison, lineage, format, utils};
fn main() {
let path = Path::new("./foo/bar");
let children: Vec = lineage::get_all_children(&path.to_path_buf()).unwrap();
// or create children from strings via
let children_from_strs = utils::tree!["./this_file.txt", "./that_file.txt"];
// get the largest file
let largest = comparison::largest_file(&children);
if let Some(file_name) = &largest.name {
println!("{:?}: {:?}", file_name, format::human_readable(largest.size, false));
}
// get only dotfiles
let dotfiles: Vec = children
.into_iter()
.filter(|path| comparison::is_dotfile(path))
.collect();
println!("{:?}", dotfiles);
}
```