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

// <FILE>src/filter/mod.rs</FILE> - <DESC>Filter module exports for gitignore pattern matching</DESC>
// <VERS>VERSION: 1.3.0</VERS>
// <WCTX>Preparing for crates.io release</WCTX>
// <CLOG>Added module documentation</CLOG>

//! Gitignore pattern matching and file filtering.
//!
//! This module provides `.gitignore` and `.ignore` file pattern matching
//! for filtering files during directory traversal.
//!
//! # Types
//!
//! - [`GitignoreMatcher`] - Pattern matcher that respects `.gitignore` files
//! - [`FilterResult`] - Result of applying filters to an entry
//!
//! # Example
//!
//! ```no_run
//! use fast_fs::GitignoreMatcher;
//! use std::path::Path;
//!
//! # fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let matcher = GitignoreMatcher::from_path(Path::new("/project"))?;
//!
//! if matcher.is_ignored(Path::new("/project/target/debug"), true) {
//!     println!("Path is ignored by .gitignore");
//! }
//! # Ok(())
//! # }
//! ```

/// Gitignore pattern matcher implementation
pub mod cls_gitignore_matcher;
/// Filter application functions
pub mod fnc_apply_filters;

// Re-export commonly used types
pub use cls_gitignore_matcher::GitignoreMatcher;
pub use fnc_apply_filters::{apply_filters, FilterResult};

// <FILE>src/filter/mod.rs</FILE>
// <VERS>END OF VERSION: 1.2.0</VERS>