Merge #119

119: rework features r=crepererum a=crepererum



Co-authored-by: Marco Neumann <marco@crepererum.net>

Author: bors[bot]

.github/workflows/ci.yml

@@ -33,32 +33,53 @@ jobs:
           toolchain: ${{ matrix.rust }}
           override: true
 
+      - name: Cache
+        uses: Swatinem/rust-cache@v1
+
+      - name: Install cargo-hack
+        uses: actions-rs/cargo@v1.0.3
+        with:
+          command: install
+          args: cargo-hack
+
       - name: cargo fmt
         uses: actions-rs/cargo@v1.0.3
         with:
           command: fmt
           args: --all -- --check
 
+      - name: cargo check (feature powerset)
+        uses: actions-rs/cargo@v1.0.3
+        with:
+          command: hack
+          args: check --feature-powerset --no-dev-deps --optional-deps --workspace
+
       - name: cargo build
         uses: actions-rs/cargo@v1.0.3
         with:
           command: build
-          args: --verbose --all
+          args: --verbose --all-features
+
+      - name: cargo clippy
+        uses: actions-rs/cargo@v1.0.3
+        with:
+          command: clippy
+          args: --verbose --all-features --all-targets --workspace
 
       - name: cargo test
         uses: actions-rs/cargo@v1.0.3
         with:
           command: test
-          args: --verbose --all
+          args: --verbose --all-features --workspace
 
       - name: cargo doc
         uses: actions-rs/cargo@v1.0.3
         with:
           command: doc
-          args: --verbose --all
+          args: --verbose --all-features --workspace
 
       - name: cargo bench
         uses: actions-rs/cargo@v1.0.3
         with:
           command: bench
-          args: --verbose --all -- --test
+          args: --verbose --all-features --workspace -- --test

Cargo.toml

@@ -17,20 +17,26 @@ readme = "README.md"
 edition = "2021"
 
 [dependencies]
-fixedbitset = "0.4"
-num-traits = "^0.2.4"
-rand = "0.8"
-succinct = "^0.5"
-
-[dependencies.bytecount]
-version = "0.6"
-features = ["runtime-dispatch-simd"]
+bytecount = { version = "0.6", features = ["runtime-dispatch-simd"], optional = true }
+fixedbitset = { version = "0.4", optional = true }
+num-traits = { version = "^0.2.4", optional = true }
+rand = { version = "0.8", optional = true }
+succinct = { version = "^0.5", optional = true }
 
 [dev-dependencies]
 criterion = "0.3"
 rand_chacha = "0.3"
 rand_distr = "0.4"
 
+[features]
+default = [
+    "bytecount",
+    "fixedbitset",
+    "num-traits",
+    "rand",
+    "succinct",
+]
+
 [[bench]]
 name = "filters"
 harness = false

src/filters/mod.rs

@@ -1,8 +1,14 @@
 //! Filters, Approximate Membership Queries (AMQs).
 
+#[cfg(feature = "fixedbitset")]
 pub mod bloomfilter;
+
 pub mod compat;
+
+#[cfg(all(feature = "rand", feature = "succinct"))]
 pub mod cuckoofilter;
+
+#[cfg(all(feature = "fixedbitset", feature = "succinct"))]
 pub mod quotientfilter;
 
 use std::fmt::Debug;

src/helpers.rs

@@ -1,13 +1,30 @@
+#![allow(dead_code)]
 use std::mem;
 
-use num_traits::Zero;
 use succinct::storage::BlockType;
 use succinct::IntVector;
 
+/// Our own version of `num_traits::Zero` so we don't need to depend on it just for the two types.
+pub(crate) trait NumZero {
+    fn create_zero() -> Self;
+}
+
+impl NumZero for usize {
+    fn create_zero() -> Self {
+        0
+    }
+}
+
+impl NumZero for u64 {
+    fn create_zero() -> Self {
+        0
+    }
+}
+
 /// Quicker all-zero initialization of an IntVector.
 pub(crate) fn all_zero_intvector<T>(element_bits: usize, len: usize) -> IntVector<T>
 where
-    T: BlockType + Zero,
+    T: BlockType + NumZero,
 {
     let n_blocks = {
         let bits = mem::size_of::<T>()
@@ -23,5 +40,5 @@ where
             blocks
         }
     };
-    IntVector::block_with_fill(element_bits, n_blocks, T::zero())
+    IntVector::block_with_fill(element_bits, n_blocks, T::create_zero())
 }

src/lib.rs

@@ -19,17 +19,34 @@
 #![deny(unsafe_code)]
 #![deny(unused_extern_crates)]
 
+#[cfg(feature = "num-traits")]
 pub use num_traits;
+
+#[cfg(feature = "rand")]
 pub use rand;
 
+#[cfg(feature = "num-traits")]
 pub mod countminsketch;
+
 pub mod filters;
+
 pub mod hash_utils;
+
+#[cfg(feature = "succinct")]
 mod helpers;
+
+#[cfg(feature = "bytecount")]
 pub mod hyperloglog;
+
+#[cfg(feature = "bytecount")]
 mod hyperloglog_data;
+
+#[cfg(feature = "rand")]
 pub mod reservoirsampling;
+
+#[cfg(feature = "rand")]
 pub mod tdigest;
+
 pub mod topk;
 
 #[cfg(test)]

src/topk/mod.rs

@@ -1,3 +1,5 @@
 //! Top-K, store `k` most frequent data points in stream.
+#[cfg(feature = "num-traits")]
 pub mod cmsheap;
+
 pub mod lossycounter;