File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -27,7 +27,7 @@ impl NodeKind {
2727 }
2828
2929 /// Stable lowercase name, for naming both sides of a kind disagreement in
30- /// [`CorruptionDetail::NodeKindMismatch`].
30+ /// [`crate::errors:: CorruptionDetail::NodeKindMismatch`].
3131 #[ must_use]
3232 pub const fn name ( self ) -> & ' static str {
3333 match self {
@@ -123,7 +123,8 @@ pub fn read_header(body: &[u8]) -> Result<NodeHeader> {
123123/// entry are attacker- or bug-controlled `u16`s that the decoders and the
124124/// zero-copy accessors use directly as slice indices. Without this pass a
125125/// malformed-but-authenticated page panics the library (an out-of-range slice
126- /// index) instead of surfacing as [`CorruptionDetail::NodeBodyMalformed`],
126+ /// index) instead of surfacing as
127+ /// [`crate::errors::CorruptionDetail::NodeBodyMalformed`],
127128/// which is a strictly worse failure than the one it would report.
128129///
129130/// Every constructor that turns raw bytes into a node runs this first, so the
Original file line number Diff line number Diff line change @@ -80,7 +80,7 @@ impl<V: Vfs + Clone> Db<V> {
8080 /// truncates `main.db` if no reader pins the old high-water range, and
8181 /// repacks segment files whose garbage ratio exceeds 5%.
8282 ///
83- /// Returns a [`CompactStats`] summary of what was reclaimed.
83+ /// Returns a [`crate:: CompactStats`] summary of what was reclaimed.
8484 pub async fn compact_now ( & self ) -> Result < crate :: compaction:: CompactStats > {
8585 self . ensure_usable ( ) ?;
8686 crate :: compaction:: compact_now ( self ) . await
@@ -93,8 +93,9 @@ impl<V: Vfs + Clone> Db<V> {
9393 /// each call, so a crash mid-compaction is safe: call `compact_step` again
9494 /// after reopening to resume from where it left off.
9595 ///
96- /// Returns a [`CompactProgress`] describing what was done and whether more
97- /// work remains. Loop until `progress.more_work == false` to compact fully.
96+ /// Returns a [`crate::CompactProgress`] describing what was done and
97+ /// whether more work remains. Loop until `progress.more_work == false` to
98+ /// compact fully.
9899 pub async fn compact_step (
99100 & self ,
100101 budget : crate :: compaction:: CompactBudget ,
Original file line number Diff line number Diff line change @@ -33,7 +33,7 @@ impl<V: Vfs + Clone> Db<V> {
3333 ) )
3434 }
3535
36- /// Like [`begin_read`] but marks the reader as non-abortable. The
36+ /// Like [`Self:: begin_read`] but marks the reader as non-abortable. The
3737 /// `AbortOldest` stall policy skips non-abortable readers; if all blocking
3838 /// readers are non-abortable, the policy falls through to `Reject`
3939 /// semantics for the writer.
Original file line number Diff line number Diff line change 44//!
55//! The embedder must serve `opfs_worker.js` at a URL the browser can load as
66//! a dedicated Web Worker. The JS source is embedded in this crate and
7- //! accessible via [`OPFS_WORKER_JS`]. A minimal bootstrap:
7+ //! accessible via the `OPFS_WORKER_JS` constant, which — like the rest of the
8+ //! backend — exists only under the compile gating described below, so it does
9+ //! not appear in documentation built for a native target. A minimal bootstrap:
810//!
911//! ```js
1012//! // Write OPFS_WORKER_JS to a blob URL or serve it statically, then:
Original file line number Diff line number Diff line change 44//!
55//! The full implementation is compiled only for `cfg(target_os = "wasi")`.
66//! On every other target a thin shim is compiled instead; the constructor
7- //! returns [`PagedbError::Unsupported`] and every method is unreachable.
7+ //! returns [`crate::PagedbError::Unsupported`] and every method is
8+ //! unreachable.
89//!
910//! # Locking
1011//!
You can’t perform that action at this time.
0 commit comments