summaryrefslogtreecommitdiffstats
path: root/third_party/rust/rust_cascade/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/rust_cascade/README.md')
-rw-r--r--third_party/rust/rust_cascade/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/third_party/rust/rust_cascade/README.md b/third_party/rust/rust_cascade/README.md
new file mode 100644
index 0000000000..206bff9267
--- /dev/null
+++ b/third_party/rust/rust_cascade/README.md
@@ -0,0 +1,12 @@
+# rust-cascade
+A Bloom filter cascade implementation in rust. This can utilize one of two hash
+functions:
+
+* MurmurHash32, or
+* SHA256, with an optional salt
+
+This implementation is designed to match up with the Python [filter-cascade
+project](https://pypi.org/project/filtercascade/)
+[[github](https://github.com/mozilla/filter-cascade)]
+
+See tests in src/lib.rs to get an idea of usage.