Skip to main content

Crate reference_query

Crate reference_query 

Source
Expand description

rq — a code navigation engine.

The goal is to reach the file, symbol, or definition a developer is most likely looking for as fast as possible — not to enumerate every match. See docs/ARCHITECTURE.md for the design these modules implement.

Modules§

cli
Command-line surface. Search is the default action: rq <query>.
core
Language-agnostic core: the common symbol model and repository identity.
index
Indexing — walk a checkout, extract symbols, persist incrementally.
lang
Language plugins — the only seam languages plug into.
search
Search — the staged ranking pipeline.
store
Storage — SQLite (WAL mode), schema, and queries.
trace
Opt-in diagnostics. rq -v (or RQ_LOG set in the environment, so an already-installed binary can be debugged without a rebuild) turns on stderr trace lines describing what each search and index pass decided — the resolved root and coverage, what got warmed, written, or reconciled away, and how long the search took. Off by default; when off it’s a single relaxed atomic load, so it costs nothing on the hot path. Trace goes to stderr, never stdout, so results stay machine-parseable.

Macros§

trace
Emit a trace line to stderr (prefixed rq:), only when enabled.