Struct xvc_walker::WalkOptions

pub struct WalkOptions {
    pub ignore_filename: Option<String>,
    pub include_dirs: bool,
}

What’s the ignore file name and should we add directories to the result?

Fields

ignore_filename: Option<String>

The ignore filename (.gitignore, .xvcignore, .ignore, etc.) or None for not ignoring anything.

include_dirs: bool

Should the results include directories themselves? Note that they are always traversed, but may not be listed if we’re only interested in actual files.

Implementations

impl WalkOptions

pub fn gitignore() -> Self

Instantiate a Git repository walker that uses .gitignore as ignore file name and includes directories in results.

pub fn xvcignore() -> Self

Instantiate a Xvc repository walker that uses .xvcignore as ignore file name and includes directories in results.

pub fn without_dirs(self) -> Self

Return options with include_dirs turned off. WalkOptions::xvcignore().without_dirs() specifies a xvcignore walker that only lists files.

pub fn with_dirs(self) -> Self

Return the same option with include_dirs turned on.

Trait Implementations

impl Clone for WalkOptions

fn clone(&self) -> WalkOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WalkOptions

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

Formats the value using the given formatter.