Crate fathomdb 

FathomDB facade crate — re-exports the public Rust surface of fathomdb-engine.

The default (operator-feature-OFF) surface is the governed application surface (dev/interfaces/rust.md § Governed-surface contract): it is recovery-name-free and raw-SQL-free at the method level. The operator/recovery seam (rebuild_*, excise_source, dump_*, trace_source_ref, truncate_wal, verify_embedder, check_integrity, safe_export, recompute_mean + their report types) is gated behind the operator cargo feature, which fathomdb-cli enables. Gating, not deletion: engine behavior is identical with the feature on. See AC-074 (dev/acceptance.md) + dev/design/slice-27-fix1-operator-gate-design.md.

Structs

CorruptionDetail

Stable corruption-on-open detail carried by EngineOpenError::Corruption.

CounterSnapshot

Snapshot of engine-internal counters returned by Engine::counters.

Engine

Explanation

0.8.8 EXP-OBS (Slice 5) — the opt-in retrieval explanation payload returned behind search_explained (the explain=true surface). Built from the engine’s OWN fusion/rerank machinery (fuse_three_arms per-arm ranks, ce_rerank blend components) — no parallel machinery (R-OBS-3). Carries a query-level QueryTrace plus a per-hit breakdown parallel to (and in the same order as) SearchResult.results.

ExtractDocument

G11 (Slice 15) — a document sent to a BYO-LLM extraction harness via Engine::ingest_with_extractor.

IngestWithExtractorReceipt

G11 (Slice 15) — receipt returned by Engine::ingest_with_extractor.

NodeRecord

Slice 30 (G2) — an active canonical node row returned by read.get / read.get_many.

OpenReport

OpenedEngine

PerHitExplain

0.8.8 EXP-OBS (Slice 5) — per-hit provenance + score breakdown. One entry per returned SearchHit, same order. *_rank is the 0-based rank the hit’s body held in that arm’s pre-fusion list (None = absent from that arm).

QueryTrace

0.8.8 EXP-OBS (Slice 5) — query-level retrieval trace. Reuses the existing search_reranked knobs + the active embedder identity; timings are coarse per-stage wall-clock (monotonic) captured only on the explain path.

RecoveryHint

Recovery dispatch surface attached to a corruption detail.

SearchExpandResult

Slice 20 (G6) — result of Engine::search_expand: initial search hits plus nodes reached by bounded BFS expansion that are not already in the search hit set.

SearchFilter

G10 — closed metadata filter for Engine::search_filtered (Slice 10).

SearchResult

Hybrid search result. results carries structured SearchHits in vector-first, dedup-on-body order. Derives Clone, Debug, PartialEq but not Eq — each hit carries a score: f64.

SoftFallback

Soft-fallback signal carried on hybrid search results.

Subscription

Handle returned by Engine::subscribe.

WriteReceipt

Enums

ComparisonOp

G4 (Slice 35) — comparison operator for Predicate::JsonPathCompare.

CorruptionKind

Open-path corruption category.

CorruptionLocator

Locator pointing at the corrupted region of the database file.

EngineError

EngineOpenError

OpenStage

Engine.open stage at which corruption was detected.

Predicate

G4 (Slice 35) — closed typed predicate for Engine::read_list filter.

PreparedWrite

Batch input shape for Engine::write.

ScalarValue

G4 (Slice 35) — scalar value for Predicate comparisons.

SoftFallbackBranch

Which retrieval branch produced a hit (or could not contribute).

TraversalDirection

Slice 20 (G5) — direction of graph traversal for Engine::graph_neighbors / Engine::search_expand.