Repository navigation
Document logic errors from mutating stored keys and values - #454
Open
RanaPriyansh wants to merge 1 commit into
Open
RanaPriyansh wants to merge 1 commit into
RanaPriyansh wants to merge 1 commit into
Conversation
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.
The main
IndexMapandIndexSetdocumentation does not describe the logic errors already documented byMutableKeysandMutableValues.Add type-level sections that explain how changing a stored key or value's hash or equality behavior can break lookup and uniqueness invariants. Link the existing mutable traits and retain their memory-safety distinction. No runtime behavior changes.
Related to #453.
Verification with Rust 1.94.1:
RUSTDOCFLAGS='-D warnings' cargo doc --no-deps --all-featurescargo test --doc --all-featurescargo clippy --all-featurescargo fmt --all -- --checkThe rendered sections and trait links were also checked. AI-assisted implementation and verification; independent agent review. The full CI platform matrix was not run locally.