Skip to content

Commit bce276c

Browse files
committed
Add cargo features table
1 parent cbec29a commit bce276c

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@
6464
//! By default the crate uses [parking_lot](https://crates.io/crates/parking_lot), which is enabled (by default) via
6565
//! a crate feature with the same name. If the `parking_lot` feature is disabled the crate defaults to the std lib
6666
//! implementation instead.
67+
//!
68+
//! # Cargo Features
69+
//!
70+
//! | Feature | Default | Description |
71+
//! |---------|---------|-------------|
72+
//! | `ahash` | ✓ | Use [ahash](https://crates.io/crates/ahash) as the default hasher. When disabled, falls back to std lib's `RandomState` (currently SipHash-1-3). |
73+
//! | `parking_lot` | ✓ | Use [parking_lot](https://crates.io/crates/parking_lot) for synchronization primitives. When disabled, falls back to std lib's `RwLock`. |
74+
//! | `shuttle` | | Enable [shuttle](https://crates.io/crates/shuttle) testing support for concurrency testing. |
75+
//! | `stats` | | Enable cache statistics tracking via the `hits()` and `misses()` methods. |
6776
#![allow(clippy::type_complexity)]
6877
#![cfg_attr(docsrs, feature(doc_cfg))]
6978

0 commit comments

Comments
 (0)