#8 implement serde feature

yankun1992 · Aug 23, 2023 · a5390bb · a5390bb
1 parent c4fa867
commit a5390bb
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/fastbloom-rs/Cargo.toml b/fastbloom-rs/Cargo.toml
@@ -19,4 +19,8 @@ license = "Apache-2.0"
 fastmurmur3 = "0.1.2"
 cuckoofilter = "0.5.0"
 xorfilter-rs = "0.5.1"
-xxhash-rust = { version = "0.8", features = ["xxh3", "const_xxh3"] }
+xxhash-rust = { version = "0.8", features = ["xxh3", "const_xxh3"] }
+serde = { version = "1.0.185", features = ["derive"], optional = true }
+
+[features]
+serde = ["dep:serde"]
diff --git a/fastbloom-rs/src/bloom.rs b/fastbloom-rs/src/bloom.rs
@@ -84,6 +84,7 @@ fn get_bit_indices(bit_set: &BloomBitVec, value: &[u8], m: u64, k: u64) -> Vec<u
 /// [Full text article](http://crystal.uta.edu/~mcguigan/cse6350/papers/Bloom.pdf)
 #[derive(Clone)]
 #[derive(Debug)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct BloomFilter {
     config: FilterBuilder,
     bit_set: BloomBitVec,

diff --git a/fastbloom-rs/src/builder.rs b/fastbloom-rs/src/builder.rs
@@ -4,6 +4,7 @@ use crate::Membership;
 /// Builder for Bloom Filters.
 #[derive(Clone)]
 #[derive(Debug)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct FilterBuilder {
     pub expected_elements: u64,
     pub false_positive_probability: f64,

diff --git a/fastbloom-rs/src/vec.rs b/fastbloom-rs/src/vec.rs
@@ -10,6 +10,7 @@ fn get_usize_len() -> usize {
 /// bitmap only for bloom filter.
 #[derive(Debug)]
 #[derive(Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub(crate) struct BloomBitVec {
     /// Internal representation of the bit vector
     pub(crate) storage: Vec<usize>,