Crate xvc_walker

Xvc walker traverses directory trees with ignore rules.

Ignore rules are similar to .gitignore and child directories are not traversed if ignored.

walk_parallel function is the most useful element in this module. It walks and sends PathMetadata through a channel, also updating the ignore rules and sending them.

Re-exports

pub use abspath::AbsolutePath;

pub use error::Error;

pub use error::Result;

pub use globset;

Modules

abspath

An absolute path type to ensure that we don’t use relative paths.

error

Error codes and messages for Xvc Walker

notify

A libnotify based file system notification module that considers ignore rules.

Macros

Hash

Derive macro generating an impl of the trait Hash.

Structs

Glob

Glob represents a successfully parsed shell glob pattern.

GlobSet

GlobSet represents a group of globs that can be matched together in a single pass.

GlobSetBuilder

GlobSetBuilder builds a group of patterns that can be used to simultaneously match a file path.

IgnoreRules

Complete set of ignore rules for a directory and its child directories.

PathMetadata

Combine a path and its metadata in a single struct

Pattern

Pattern is generic and could be an instance of String, Glob, Regex or any other object. The type is evolved by compiling. A pattern can start its life as Pattern<String> and can be compiled into Pattern<Glob> or Pattern<Regex>.

WalkOptions

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

Enums

MatchResult

Show whether a path matches to a glob rule

PathKind

Is the path only a directory, or could it be directory or file?

PatternEffect

Is this pattern a ignore or whitelist patter?

PatternRelativity

Is the pattern matches anywhere or only relative to a directory?

Source

Do we get this pattern from a file (.gitignore, .xvcignore, …) or specify it directly in code?

Traits

Hash

A hashable type.

Functions

build_ignore_rules

Just build the ignore rules with the given directory

check_ignore

Check whether path is whitelisted or ignored with ignore_rules

content_to_patterns

convert a set of rules in content to glob patterns. patterns may come from source. the root directory of all search is in ignore_root.

directory_list

Return all childs of a directory regardless of any ignore rules If there is an error to obtain the metadata, error is added to the element instead

merge_ignores

merge ignore rules in a single set of ignore rules.

walk_parallel

Walk all child paths under dir and send non-ignored paths to path_sender. Newly found ignore rules are sent through ignore_sender. The ignore file name (.xvcignore, .gitignore, .ignore, …) is set by walk_options.

walk_serial

Walk dir with walk_options, with the given initial ignore_rules. Note that ignore rules are expanded with the rules given in the ignore_filename in walk_options. The result is added to given res_paths to reduce the number of memory inits for vec.