Struct DirectoryScanner

pub struct DirectoryScanner { /* private fields */ }

A directory scanner with configurable iteration behaviour.

Alternatives

This scanner is able to recursively iterate over the directory as well as optionally follow symbolic links. If, however, you’re looking for something with a bit more features, such as sorting, and a longer history of ecosystem use, consider the walkdir crate, which this scanner has been inspired by.

Implementations

impl DirectoryScanner

pub fn new<P>(base_directory_path: P, options: DirectoryScanOptions) -> Self

where P: Into<PathBuf>,

Initializes the directory scanner.

This call will not interact with the filesystem yet. To turn this scanner struct into a breadth-first recursive iterator, call its into_iter method.

Trait Implementations

impl IntoIterator for DirectoryScanner

type IntoIter = BreadthFirstDirectoryIter

Which kind of iterator are we turning this into?

type Item = Result<ScanEntry, DirectoryScanError>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.