fast-fs 0.2.1

High-speed async file system traversal library with batteries-included file browser component
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
50
51
52

// <FILE>crates/fast-fs/src/reader/mod.rs</FILE> - <DESC>Reader module</DESC>
// <VERS>VERSION: 0.7.0</VERS>
// <WCTX>Preparing for crates.io release</WCTX>
// <CLOG>Added module documentation</CLOG>

//! Async directory reading functions.
//!
//! This module provides non-blocking directory traversal using tokio's async I/O.
//!
//! # Functions
//!
//! - [`read_dir`] - Read a single directory
//! - [`read_dir_visible`] - Read non-hidden files only
//! - [`read_dir_recursive`] - Recursive traversal with [`TraversalOptions`]
//! - [`read_dir_stream`] - Memory-efficient streaming API
//!
//! # Example
//!
//! ```no_run
//! use fast_fs::{read_dir, read_dir_recursive, TraversalOptions};
//!
//! # async fn example() -> Result<(), fast_fs::Error> {
//! // Single directory
//! let entries = read_dir("/path/to/dir").await?;
//!
//! // Recursive with options
//! let options = TraversalOptions::default()
//!     .with_max_depth(3)
//!     .with_extensions(&["rs", "toml"]);
//! let all_entries = read_dir_recursive("/project", options).await?;
//! # Ok(())
//! # }
//! ```
//!
//! [`read_dir`]: crate::read_dir
//! [`read_dir_visible`]: crate::read_dir_visible
//! [`read_dir_recursive`]: crate::read_dir_recursive
//! [`read_dir_stream`]: crate::read_dir_stream
//! [`TraversalOptions`]: crate::TraversalOptions

mod cls_stream_state;
/// Single directory read function
pub mod fnc_read_dir;
/// Recursive directory traversal function
pub mod fnc_read_dir_recursive;
/// Streaming directory traversal function
pub mod fnc_read_dir_stream;
/// Non-hidden files only read function
pub mod fnc_read_dir_visible;

// <FILE>crates/fast-fs/src/reader/mod.rs</FILE>
// <VERS>END OF VERSION: 0.6.0</VERS>