Struct Giterator

pub struct Giterator { /* private fields */ }

A builder to define how to search for Git directories.

Implementations

impl Giterator

pub fn root<P: AsRef<Path>>(self, root: P) -> Self

Sets the apex root directory to begin searching. The directory itself will not be considered for inclusion in the final results; only directories within root.

pub fn follow_links(self, follow: bool) -> Self

Sets wether or not to follow symbolic links in the directory tree.

pub fn max_depth(self, depth: usize) -> Self

Sets the maximum number of directories from root to search. Directories more than depth directories deeper than root will not be found.

pub fn regex(self, regex: Regex) -> Self

Sets the regular expression that must match directory paths.

pub fn match_full_path(self, match_full_path: bool) -> Self

Sets wether or not to match regex against the full canonicalized directory path.

Trait Implementations

impl Debug for Giterator

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

Formats the value using the given formatter.

impl Default for Giterator

fn default() -> Self

Creates a default Giterator with the following settings:

• search the current working directory
• do not follow symbolic links
• search usize::MAX directories deep
• match any directory path

impl IntoIterator for Giterator

type Item = DirEntry

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.