Struct FilesystemSource 

pub struct FilesystemSource { /* private fields */ }

Scans files in a directory tree.

Implementations

impl FilesystemSource

pub fn new(root: PathBuf) -> Self

Create a filesystem source rooted at root.

pub fn with_window_config(self, window_size: usize, overlap: usize) -> Self

Override the windowed-scan parameters. Production callers stick with the defaults (64 MiB / 4 KiB); tests use this to exercise the multi-window path on tiny fixtures. window_size must strictly exceed overlap (the underlying slicer asserts this).

pub fn with_merkle_skip(self, merkle: Arc<MerkleIndex>) -> Self

Wire the source up to a merkle index so (path, mtime, size) matches skip the file before it is read. The cache contents themselves are loaded by the orchestrator (which also handles detector-spec-hash invalidation) and shared via Arc so multiple sources can consult one index.

pub fn skipped_counter(&self) -> Arc<AtomicUsize>

Returns a counter that the source increments every time the metadata fast-path skips a file. Cloned Arc<AtomicUsize>, safe to read after the iterator drains.

pub fn with_include_paths(self, paths: Vec<PathBuf>) -> Self

Only include files whose paths match one of the given paths. Paths are compared against the absolute path of each discovered file.

pub fn with_max_file_size(self, bytes: u64) -> Self

Override the maximum file size scanned from disk.

pub fn with_ignore_paths(self, paths: Vec<String>) -> Self

Add patterns to ignore during the walk.

pub fn with_respect_gitignore(self, respect: bool) -> Self

Override whether the walk honors .gitignore / .keyhogignore. keyhog scan-system flips this to false so a leaked key stashed in .gitignore can’t hide.

Trait Implementations

impl Source for FilesystemSource

fn name(&self) -> &str

Human-readable source name used in warnings and telemetry.

fn chunks(&self) -> Box<dyn Iterator<Item = Result<Chunk, SourceError>> + '_>

Yield all readable chunks from this source.

fn as_any(&self) -> &dyn Any

Support downcasting to concrete types.