Skip to content

Commit 1e83a08

Browse files
committed
Add docs about the features, and replace dead_code with feature gating
1 parent 2a1d783 commit 1e83a08

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

src/api/blobs.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,15 @@ impl Blobs {
144144
/// clears the protections before.
145145
///
146146
/// Users should rely only on garbage collection for blob deletion.
147-
#[allow(dead_code)]
147+
#[cfg(feature = "fs-store")]
148148
pub(crate) async fn delete_with_opts(&self, options: DeleteOptions) -> RequestResult<()> {
149149
trace!("{options:?}");
150150
self.client.rpc(options).await??;
151151
Ok(())
152152
}
153153

154154
/// See [`Self::delete_with_opts`].
155-
#[allow(dead_code)]
155+
#[cfg(feature = "fs-store")]
156156
pub(crate) async fn delete(
157157
&self,
158158
hashes: impl IntoIterator<Item = impl Into<Hash>>,

src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
//! The [downloader](api::downloader) module provides a component to download blobs from
2525
//! multiple sources and store them in a store.
2626
//!
27+
//! # Features:
28+
//!
29+
//! - `fs-store`: Enables the filesystem based store implementation. This comes with a few additional dependencies such as `redb` and `reflink-copy`.
30+
//! - `metrics`: Enables prometheus metrics for stores and the protocol.
31+
//!
2732
//! [BLAKE3]: https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf
2833
//! [iroh]: https://docs.rs/iroh
2934
mod hash;

0 commit comments

Comments
 (0)