fast_fs/reader/
mod.rs

1// <FILE>crates/fast-fs/src/reader/mod.rs</FILE> - <DESC>Reader module</DESC>
2// <VERS>VERSION: 0.7.0</VERS>
3// <WCTX>Preparing for crates.io release</WCTX>
4// <CLOG>Added module documentation</CLOG>
5
6//! Async directory reading functions.
7//!
8//! This module provides non-blocking directory traversal using tokio's async I/O.
9//!
10//! # Functions
11//!
12//! - [`read_dir`] - Read a single directory
13//! - [`read_dir_visible`] - Read non-hidden files only
14//! - [`read_dir_recursive`] - Recursive traversal with [`TraversalOptions`]
15//! - [`read_dir_stream`] - Memory-efficient streaming API
16//!
17//! # Example
18//!
19//! ```no_run
20//! use fast_fs::{read_dir, read_dir_recursive, TraversalOptions};
21//!
22//! # async fn example() -> Result<(), fast_fs::Error> {
23//! // Single directory
24//! let entries = read_dir("/path/to/dir").await?;
25//!
26//! // Recursive with options
27//! let options = TraversalOptions::default()
28//!     .with_max_depth(3)
29//!     .with_extensions(&["rs", "toml"]);
30//! let all_entries = read_dir_recursive("/project", options).await?;
31//! # Ok(())
32//! # }
33//! ```
34//!
35//! [`read_dir`]: crate::read_dir
36//! [`read_dir_visible`]: crate::read_dir_visible
37//! [`read_dir_recursive`]: crate::read_dir_recursive
38//! [`read_dir_stream`]: crate::read_dir_stream
39//! [`TraversalOptions`]: crate::TraversalOptions
40
41mod cls_stream_state;
42/// Single directory read function
43pub mod fnc_read_dir;
44/// Recursive directory traversal function
45pub mod fnc_read_dir_recursive;
46/// Streaming directory traversal function
47pub mod fnc_read_dir_stream;
48/// Non-hidden files only read function
49pub mod fnc_read_dir_visible;
50
51// <FILE>crates/fast-fs/src/reader/mod.rs</FILE>
52// <VERS>END OF VERSION: 0.6.0</VERS>
fast_fs/reader/mod.rs

fast_fs/reader/
mod.rs
