Skip to main content

Crate fathomdb

Crate fathomdb 

Source
Expand description

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
OpenReport
OpenedEngine
RecoveryHint
Recovery dispatch surface attached to a corruption detail.
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§

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.
PreparedWrite
Batch input shape for Engine::write.
SoftFallbackBranch
Which retrieval branch could not contribute to a hybrid search.