Struct fs_more::directory::DirectoryScanOptions

pub struct DirectoryScanOptions {
    pub maximum_scan_depth: DirectoryScanDepthLimit,
    pub follow_symbolic_links: bool,
}

Options that influence DirectoryScan.

Fields

maximum_scan_depth: DirectoryScanDepthLimit

The maximum directory scanning depth, see DirectoryScanDepthLimit.

follow_symbolic_links: bool

Whether to follow symbolic links when scanning or not.

If enabled

We’ll follow the symbolic links, even if they lead outside the base directory_path. Note that this means the files and directories included in the scan results might not necessarily be sub-paths of the provided base directory_path.

If a symbolic link turns out to be broken (its destination doesn’t exist), it is simply ignored (not included in the scan results).

If disabled

When we encounter a symbolic link, the results will include the file path of the symbolic link itself, not the link’s destination path.

If an encountered symbolic link points to a directory, it will be included in the results in a similar manner, but with one significant difference: as we won’t resolve symbolic links, the files and subdirectories of that symlinked directory will not be scanned, even if the scan depth limit would have allowed it.

If a symbolic link turns out to be broken (its destination doesn’t exist), it is simply ignored (not included in the scan results).

Trait Implementations

impl Clone for DirectoryScanOptions

fn clone(&self) -> DirectoryScanOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryScanOptions

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

Formats the value using the given formatter.

impl Default for DirectoryScanOptions

fn default() -> Self

Returns the default directory scanning options, which are:

• unlimited scan depth,
• symlinks are no followed.

impl PartialEq for DirectoryScanOptions

fn eq(&self, other: &DirectoryScanOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DirectoryScanOptions

impl StructuralPartialEq for DirectoryScanOptions