Expand description
Deterministic, safe repository scanning for code-intelligence tools.
weavatrix-scan never executes repository code or reads outside the
repository boundary. Symbolic links are skipped by default and guarded by
boundary/cycle checks when explicitly enabled.
Use ScanReport::to_portable to cross trust boundaries without exposing
host paths, and ScanReport::content_provider to reopen selected content
with snapshot verification.
Structs§
- Cancellation
Token - A cheap, thread-safe cancellation signal shared by walkers and scanners.
- Changed
Content Visit Report - Content and removals produced by a safe file-only watcher plan.
- Compact
Content Evidence - Optional rich evidence kept out of metadata-only compact entries.
- Compact
Scan Report - Memory-efficient deterministic manifest retaining the root path once.
- Compact
Scanned File - Selected-file evidence without a duplicated absolute path allocation.
- Content
File - Stable identity and discovery evidence for one selected file.
- Content
Visit Report - Summary of a parallel, one-pass selected-content visit.
- File
Identity - File
Version - Ignore
File - Ignore
Policy - Controls every supported source of repository selection rules.
- Ignore
Source Evidence - Modified
File - A selected file whose stable relative path remained but content changed.
- Multi
Content Visit Report - Ordered summaries from a multi-root content visit.
- Multi
Scan Report - Deterministic collection of independently rooted scan reports.
- Multi
Scanner - Scans independent roots concurrently while preserving report order.
- Multi
Walker - Iterator returned by
WalkBuilder. - Named
File Types - Named, reusable groups of file-name or repository-relative glob patterns.
- Parallel
Multi Visit Report - Per-root streaming reports in root insertion order.
- Parallel
Multi Walk Event - A streaming event tagged with its root’s insertion index and path.
- Parallel
Multi Walk Report - Collected raw walk reports for independent roots in insertion order.
- Parallel
Multi Walker - Walks independent raw roots concurrently while preserving root order.
- Parallel
Runtime - Selects where parallel traversal jobs execute.
- Parallel
Stateful Walker - Bounded stateful pull iterator with parallel directory processing and strict deterministic depth-first output.
- Parallel
Visit Report - Summary of a streaming parallel traversal.
- Parallel
Walk Iter - Bounded pull iterator backed by parallel traversal workers.
- Parallel
Walk Report - Collected output from a parallel filesystem walk.
- Parallel
Walker - An adaptive parallel filesystem walker.
- Portable
Ignore Source Evidence - Ignore-source evidence with external host paths removed.
- Portable
Scan Report - A deterministic report suitable for crossing a repository or process boundary.
- Portable
Scan Warning - Warning evidence that cannot expose paths embedded in an OS error message.
- Portable
Scanned File - A selected file without host-local absolute paths or file identities.
- Portable
Skipped Entry - Typed skip evidence with free-form details replaced by a stable hash.
- Renamed
File - A uniquely content-matched file whose stable relative path changed.
- Repository
Matcher - A reusable, lazily cached repository ignore matcher.
- Scan
Cache - Versioned local cache for incremental scans.
- Scan
Cache Entry - Compact reusable evidence for one content-hashed file.
- Scan
Cache Stats - Scan
Delta - Deterministic changes between two repository manifests.
- Scan
Limits - Hard bounds for hostile or unexpectedly large repository trees.
- Scan
Options - Scan
Report - Scan
Stream Report - Summary of deterministic, backpressured scan emission.
- Scan
Warning - Scanned
File - Scanner
- Skipped
Entry - Snapshot
Content - File bytes verified against the selected scan entry.
- Snapshot
Content Provider - Reads only files recorded in one validated
ScanReport. - Stateful
Walk Builder - Builder for an iterative DFS walk with per-directory and per-entry state.
- Stateful
Walk Entry - A walk entry carrying caller-owned state assigned by
process_read_dir. - Stateful
Walker - Strict depth-first iterator produced by
StatefulWalkBuilder. - Walk
Builder - Configures flexible single- or multi-root walking.
- Walk
Entry - Walk
Error - Walk
Options - Walker
- Iterative depth-first filesystem walker.
- Watch
Event - One raw path event supplied by a filesystem watcher.
- Watch
Plan - Deterministic invalidation plan derived from watcher events.
- Watcher
Event Adapter - Converts watcher-specific path notifications into scanner cache work.
Enums§
- Cache
Validation Policy - Controls how persistent content hashes are validated before reuse.
- Changed
Content Visit Outcome - Result of attempting a traversal-free watcher content visit.
- Content
File Status - Result of verifying the file around its single content read.
- Content
Validation Policy - Controls post-read snapshot verification for newly opened content.
- Content
Visit Control - Controls delivery from
crate::Scanner::visit_content. - Content
Visit Event - Events emitted from one bounded content worker.
- Content
Visit Mode - Controls whether a content visit retains selected-file evidence internally.
- Delta
Quality - Strength of the evidence used to classify a scan delta.
- Error
- Error
Policy - Evidence
Mode - Ignore
Source Kind - Repository
Match - Highest-precedence selection decision for a repository path.
- Root
Symlink Policy - Controls whether the explicitly supplied root itself may be a symlink.
- Scan
Sink Control - Controls deterministic file emission from
crate::Scanner::scan_into. - Scan
Termination - Skip
Kind - Snapshot
Evidence - Evidence used to bind returned bytes to a scan snapshot.
- Snapshot
Read Error - A path-safe failure from snapshot content access.
- Standard
Skips - Walk
Control - Controls traversal after a streaming visitor handles an event.
- Walk
Event - A streaming event emitted from a parallel traversal worker.
- Walk
Operation - Walk
Skip Reason - Watch
Event Kind - Normalized watcher event category independent of a watcher implementation.
Constants§
- SCAN_
CACHE_ FORMAT_ VERSION - Current on-disk format understood by
ScanCache.
Traits§
- Parallel
Executor - Adapter contract for an application-owned thread pool.
- Scan
Sink - Synchronous consumer for selected scan entries.
Functions§
- scan_
repository - Scans a repository with default options.
- scan_
repository_ compact - Scans a repository into a root-shared compact manifest.
Type Aliases§
- Parallel
Job - A job accepted by an embeddable
ParallelExecutor. - Result