Struct itree::options::FsOptions

pub struct FsOptions<P: AsRef<Path>> {
    pub root: P,
    pub max_depth: Option<usize>,
    pub follow_links: bool,
    pub max_filesize: Option<u64>,
    pub hidden: bool,
    pub only_dirs: bool,
    pub no_ignore: bool,
    pub no_git_exclude: bool,
    pub custom_ignore: Vec<String>,
}

Fields

root: P

max_depth: Option<usize>

follow_links: bool

max_filesize: Option<u64>

hidden: bool

only_dirs: bool

no_ignore: bool

no_git_exclude: bool

custom_ignore: Vec<String>

Methods

impl<P: AsRef<Path>> FsOptions<P>

pub fn new(root: P) -> Self

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn root(&mut self, root: P) -> &mut Self

Set the root directory from which to build the tree.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn max_depth(&mut self, max_depth: Option<usize>) -> &mut Self

Set a maximum depth for the tree to search. None indicates no limit.

None by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set whether or not to follow links.

Disabled by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn max_filesize(&mut self, max_filesize: Option<u64>) -> &mut Self

Set a maximum file size to include. None indicates no limit.

None by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn hidden(&mut self, hidden: bool) -> &mut Self

Set whether or not to ignore hidden files.

Enabled by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn only_dirs(&mut self, only_dirs: bool) -> &mut Self

Set whether or not to consider directories only.

Disabled by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn no_ignore(&mut self, no_ignore: bool) -> &mut Self

Set whether or not to read .[git]ignore files.

Enabled by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn no_git_exclude(&mut self, no_git_exclude: bool) -> &mut Self

Set whether or not to read .git/info/exclude files.

Enabled by default.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn add_custom_ignore(&mut self, path: &str) -> &mut Self

Add a custom ignore path.

Trait Implementations

impl<P: Debug + AsRef<Path>> Debug for FsOptions<P>

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

Formats the value using the given formatter.