Struct IncludeExclude 

pub struct IncludeExclude { /* private fields */ }

An rsync-style include/exclude filter.

Rules are processed in order. The first matching rule determines whether the path is included or excluded. If no rule matches, the path is considered to have no explicit ruling (NoMatch).

Examples

use kaish_glob::{IncludeExclude, FilterResult};
use std::path::Path;

let mut filter = IncludeExclude::new();
filter.include("*.rs");
filter.exclude("*_test.rs");

// Note: order matters! First match wins.
// In this case, *.rs matches first, so test files ARE included.

Implementations

impl IncludeExclude

pub fn new() -> IncludeExclude

Create an empty filter set.

pub fn include(&mut self, pattern: &str)

Add an include pattern.

Paths matching this pattern will be included (if checked before any exclude pattern matches).

pub fn exclude(&mut self, pattern: &str)

Add an exclude pattern.

Paths matching this pattern will be excluded (if checked before any include pattern matches).

pub fn check(&self, path: &Path) -> FilterResult

Check a path against the filter rules.

Returns the first matching rule’s action, or NoMatch if no rules match.

pub fn excludes_entry( &self, relative: &Path, name: Option<&Path>, is_dir: bool, ) -> bool

Decide whether a walk entry is filtered out.

relative is the walk-relative path and name the basename (patterns like *_test.rs are written against filenames); the first representation that matches any rule decides. When include rules exist, a file matching none of them is excluded — but a directory never is, so traversal can still reach included files below it. Exclude rules apply to directories too (pruning the subtree).

pub fn has_includes(&self) -> bool

Whether any include rules are present.

pub fn is_empty(&self) -> bool

Check if any rules are defined.

pub fn len(&self) -> usize

Get the number of rules.

Trait Implementations

impl Clone for IncludeExclude

fn clone(&self) -> IncludeExclude

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IncludeExclude

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for IncludeExclude

fn default() -> IncludeExclude

Returns the “default value” for a type.