Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add alternatives section to readme and docs #128

Merged
merged 2 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ under the `jsr166/` subdirectory for easy reference.
The port was developed as part of a series of [live coding streams]
kicked off by [this tweet].

## Better Alternatives

Flurry currently suffers performance and memory usage issues under load.
You may wish to consider [papaya] or [dashmap] as alternatives if this is
important to you.

## License

Licensed under either of
Expand All @@ -36,3 +42,5 @@ dual licensed as above, without any additional terms or conditions.
[live coding streams]: https://www.youtube.com/playlist?list=PLqbS7AVVErFj824-6QgnK_Za1187rNfnl
[this tweet]: https://twitter.com/jonhoo/status/1194969578855714816
[upstream tests]: https://hg.openjdk.java.net/jdk/jdk13/file/tip/test/jdk/java/util/concurrent/ConcurrentHashMap
[papaya]: https://github.com/ibraheemdev/papaya
[dashmap]: https://github.com/xacrimon/dashmap
8 changes: 8 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
//! most part has a similar API. Even though all operations on the map are thread-safe and operate
//! on shared references, retrieval operations do *not* entail locking, and there is *not* any
//! support for locking the entire table in a way that prevents all access.
//!
//! # Better Alternatives
//!
//! Flurry currently suffers performance and memory usage issues under load.
//! You may wish to consider [`papaya`] or [`dashmap`] as alternatives if this is
//! important to you.
//!
//! # A note on `Guard` and memory use
//!
Expand Down Expand Up @@ -232,6 +238,8 @@
//! operation than if every individual value had to be atomically reference-counted.
//!
//! [`seize`]: https://docs.rs/seize
//! [`papaya`]: https://docs.rs/papaya
//! [`dashmap`]: https://docs.rs/dashmap
#![deny(
missing_docs,
missing_debug_implementations,
Expand Down
Loading