Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the lockmap crate for the 0.2.3 release by updating package metadata and polishing project documentation (README + changelog) to reflect the new release, usage guidance, and licensing.
Changes:
- Add an Installation section to the README, including a
cargo addsnippet and MSRV (1.75) statement. - Document a non-reentrancy/deadlock caveat in the README and explicitly state dual licensing (MIT OR Apache-2.0).
- Finalize the changelog for
0.2.3(2026-07-16) and bumpCargo.tomlversion to0.2.3.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds installation instructions, clarifies caveats around locking behavior, and expands license text. |
| CHANGELOG.md | Renames “Unreleased” to 0.2.3 with release date and adds the compare link. |
| Cargo.toml | Bumps crate version from 0.2.2 to 0.2.3. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+172
to
+173
| Calling any map operation for a key **while already holding that key's `Entry`** deadlocks — this includes `get`, `insert`, `remove`, `entry`, and whole-map operations such as `clear`, `for_each` and `retain`. | ||
| > **Note**: Drop the guard first, or use `try_entry` / `try_entry_by_ref` when you cannot statically rule out re-entry. |
SF-Zhou
changed the title
- Add Installation section with cargo add snippet and MSRV (1.75) note - Add 'Locks Are Not Reentrant' caveat: same-key operations while holding an Entry deadlock; suggest try_entry as the escape hatch - State the MIT OR Apache-2.0 dual license explicitly in the License section instead of only the FOSSA badge - Add three self-checking examples: singleflight (request coalescing, backend hit exactly once across 8 concurrent misses), rate_limiter (per-user token bucket) and lru_session_store (bounded LRU store with peek/pop_lru) - README: add capability comparison matrix vs dashmap/moka with a rule-of-thumb selection guide, link the examples, and surface the CI verification story (Miri + TSan + MSRV + 5 targets) up front - CHANGELOG: record the documentation additions under 0.2.3
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
=======================================
Coverage 99.29% 99.29%
=======================================
Files 3 3
Lines 2272 2272
=======================================
Hits 2256 2256
Misses 16 16 ☔ View full report in Codecov by Harness. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
with peek/pop_lru)