fix: pass rustdoc test for docs.rs

Signed-off-by: MrCroxx <[email protected]>

Makefile

@@ -27,6 +27,7 @@ check-all:
 test:
 	RUST_BACKTRACE=1 cargo nextest run --all --features "strict_assertions,sanity,prometheus,prometheus-client_0_22,opentelemetry_0_26,opentelemetry_0_27"
 	RUST_BACKTRACE=1 cargo test --doc
+	RUSTDOCFLAGS="--cfg docsrs -D warnings" cargo +nightly doc --features "nightly,prometheus,prometheus-client,prometheus-client_0_22,opentelemetry,opentelemetry_0_26,opentelemetry_0_27"
 
 test-ignored:
 	RUST_BACKTRACE=1 cargo nextest run --run-ignored ignored-only --no-capture --workspace --features "strict_assertions,sanity"

foyer-memory/src/raw.rs

@@ -804,7 +804,7 @@ where
     }
 }
 
-/// The state of [`Fetch`].
+/// The state of `fetch`.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum FetchState {
     /// Cache hit.

foyer-memory/src/record.rs

@@ -38,7 +38,7 @@ pub enum CacheHint {
     Normal,
     /// Suggest the priority of the entry is low.
     ///
-    /// Used by [`crate::eviction::lru::Lru`].
+    /// Used by LRU.
     Low,
 }
 

foyer-storage/src/device/bytes.rs

@@ -436,7 +436,7 @@ impl IoBytes {
     ///
     /// Otherwise, [`None`] is returned.
     ///
-    /// It is strongly recommended to use `into_io_buffer` instead if you don't want to keep the original [`IoByes`]
+    /// It is strongly recommended to use `into_io_buffer` instead if you don't want to keep the original [`IoBytes`]
     /// in the [`Err`] path. See `Arc::try_unwrap` and `Arc::into_inner` docs.
     ///
     /// Note: The [`IoBytes`] can be a slice of the underlying [`IoBuffer`].

foyer/src/hybrid/builder.rs

@@ -269,7 +269,7 @@ where
     ///
     /// The admission picker is used to pick the entries that can be inserted into the disk cache store.
     ///
-    /// Default: [`AdmitAllPicker`].
+    /// Default: [`crate::AdmitAllPicker`].
     pub fn with_admission_picker(self, admission_picker: Arc<dyn AdmissionPicker<Key = K>>) -> Self {
         let builder = self.builder.with_admission_picker(admission_picker);
         Self {