diff options
Diffstat (limited to 'vendor/dashmap/README.md')
| -rw-r--r-- | vendor/dashmap/README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/vendor/dashmap/README.md b/vendor/dashmap/README.md new file mode 100644 index 000000000..580480f20 --- /dev/null +++ b/vendor/dashmap/README.md @@ -0,0 +1,63 @@ +# DashMap + +Blazingly fast concurrent map in Rust. + +DashMap is an implementation of a concurrent associative array/hashmap in Rust. + +DashMap tries to implement an easy to use API similar to `std::collections::HashMap` +with some slight changes to handle concurrency. + +DashMap tries to be very simple to use and to be a direct replacement for `RwLock<HashMap<K, V>>`. +To accomplish these goals, all methods take `&self` instead of modifying methods taking `&mut self`. +This allows you to put a DashMap in an `Arc<T>` and share it between threads while still being able to modify it. + +DashMap puts great effort into performance and aims to be as fast as possible. +If you have any suggestions or tips do not hesitate to open an issue or a PR. + +[](https://crates.io/crates/dashmap) + +[](https://docs.rs/dashmap) + +[](https://crates.io/crates/dashmap) + +[](https://crates.io/crates/dashmap) + +## Cargo features + +- `serde` - Enables serde support. + +- `raw-api` - Enables the unstable raw-shard api. + +- `rayon` - Enables rayon support. + +## Contributing + +DashMap gladly accepts contributions! +Do not hesitate to open issues or PR's. + +I will take a look as soon as I have time for it. + +That said I do not get paid (yet) to work on open-source. This means +that my time is limited and my work here comes after my personal life. + +## Performance + +A comprehensive benchmark suite including DashMap can be found [here](https://github.com/xacrimon/conc-map-bench). + +## Special thanks + +- [Jon Gjengset](https://github.com/jonhoo) + +- [Yato](https://github.com/RustyYato) + +- [Karl Bergström](https://github.com/kabergstrom) + +- [Dylan DPC](https://github.com/Dylan-DPC) + +- [Lokathor](https://github.com/Lokathor) + +- [namibj](https://github.com/namibj) + +## License + +This project is licensed under MIT. |