walkthrough 0.2.0

A Rust crate for recursive directory traversal.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
#![cfg_attr(test, deny(warnings))]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! # Recursive Directory Traversal
//!
//! This crate provides a flexible and efficient way to recursively walk through
//! directories. It handles common tasks like:
//!
//! * Filtering hidden files.
//! * Setting minimum and maximum recursion depth.
//! * Following or ignoring symbolic links.
//! * Sorting entries within a directory.
//! * Detecting symbolic link loops to prevent infinite recursion.
//!
//! ## Example
//!
//! ```no_run
//! use walkthrough::WalkDir;
//!
//! for entry in WalkDir::new("src").max_depth(2) {
//!     match entry {
//!         Ok(e) => println!("Found: {:?}", e.path()),
//!         Err(err) => eprintln!("Error: {}", err),
//!     }
//! }
//! ```

// Unsupported targets produce a clear compile error rather than a cryptic
// "method not found" cascade from the missing platform-specific impl modules.
#[cfg(not(any(unix, windows)))]
compile_error!("walkthrough only supports Unix and Windows targets");

mod entry;
mod error;
mod iter;
mod sync;

#[cfg(feature = "async")]
pub mod r#async;
#[cfg(feature = "async")]
pub use r#async::{Async, AsyncDirEntry, AsyncWalkDir, AsyncWalker};
pub(crate) use entry::Ancestor;
pub use entry::DirEntry;
pub use error::{Error, ErrorKind, Result};
pub use iter::WalkDir;
pub use sync::{Sync, Walker};