Skip to main content

Crate fallow_engine

Crate fallow_engine 

Source
Expand description

Typed analysis engine boundary for fallow consumers.

fallow-core remains the internal orchestration backend. This crate owns the typed boundary that editor, API, and embedding surfaces can depend on without calling deprecated core entry points directly. Public modules should expose owned engine runners, typed result structs, or narrowly scoped aliases instead of broad core re-exports.

Modules§

baseline
Finding-count and finding-identity baselines for suppressing known issues across runs.
cache_status
Read-only inspection of the persisted extraction cache, for fallow doctor. Read-only inspection of the persisted caches.
changed_files
Changed-file helpers owned by the engine boundary.
churn
Git churn analysis for hotspot detection.
ci_env
Continuous integration detection shared by the API runtime and the CLI. Continuous integration detection shared by the API runtime and the CLI.
clock
Run-scoped analysis clock.
codeowners
CODEOWNERS file parser and ownership lookup.
cross_reference
Cross-reference helpers exposed through the engine boundary.
dead_code
Dead-code result helpers exposed through the engine boundary.
diff_scope
Diff line filters shared by every surface that accepts a unified diff.
diff_source
Read a unified diff and place it under the directory its paths are relative to, or say why the run cannot.
discover
Discovery helpers and types exposed through the engine boundary.
duplicates
Duplication result types exposed through the engine boundary.
entry_weight
Startup import weight per runtime entry point.
error_severity
The error-severity rule: whether a dead-code result holds a finding whose effective severity is error.
flag_age
Flag age from git history for fallow flags --retirement.
flag_report
One entry point that builds the fallow flags --retirement report.
flag_retirement
Per-flag retirement report for fallow flags --retirement.
flag_vendor
Vendor flag state for fallow flags --retirement --flag-state <FILE>.
flags
Feature flag analysis owned by the engine boundary.
guard
Typed guard report assembly for pre-edit architecture guidance.
health
Command-neutral health execution options and runners.
list_inventory
Engine-owned inventory helpers for list-style project metadata.
module_graph
Module graph contracts owned by the engine boundary.
plugins
Plugin registry helpers and types exposed through the engine boundary.
project_analysis
Project-level analysis contracts owned by the engine boundary.
project_config
Project config resolution owned by the engine boundary.
repo_refs
Engine-owned repository reference probes and temporary repo views.
session
Engine-owned analysis session orchestration.
similar_code
Pure, bounded evaluation of provider-supplied code vectors.
source
Source parsing contracts owned by the engine boundary.
test_paths
Shared classification of test paths.
thread_pool
Shared Rayon pool construction for analysis workloads.
trace
Read-only trace helpers exposed through the engine boundary.
trace_chain
Symbol trace types exposed through the engine boundary.
trace_error
fallow trace-error: resolve a runtime stack trace’s frames against the project graph.
validate
Input validation shared by CLI-facing entry points: git refs, root paths, and control-character rejection.
vital_signs
Vital signs computation and snapshot persistence.
viz
Typed data contract and builder for fallow viz.
warm_parse
Parsed modules that a long-lived process keeps across analysis sessions.
workspace_scope
Workspace scoping owned by the engine boundary.
write_guard
Confine the files that a run writes on request (baselines, snapshots and report files) to the project.

Structs§

EngineError
Error type exposed by the typed engine boundary.

Type Aliases§

EngineResult
Result alias for typed engine operations.