Add safety preconditions to alloc/src/collections/binary_heap/mod.rs #120
Conversation
This file contains 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
This diff adds `#[requires(...)]` attributes to the unsafe functions, translating the "SAFETY:" comments into code contracts. These contracts specify the preconditions that must be met for the function to be safely called.
tautschnig
force-pushed
the
bedrock-library/alloc/src/collections/binary_heap/mod.rs
branch
from
29b2c87 to
8e6b212
Compare
Just as previously done for core: this will enable future use of
`safety::{ensures,requires}` in those crates.
celinval
reviewed
Oct 17, 2024
There was a problem hiding this comment.
Do these function require self to be safe?
There was a problem hiding this comment.
Are you asking whether there are requirements that the object is in some sort of sane state? I would believe so, but why would we ever permit for that not to be the case?
There was a problem hiding this comment.
I agree that we shouldn't, but we do.
Conceptually, internal functions can temporary break the safety invariants of the types.
celinval
reviewed
Oct 18, 2024
| mod verify { | ||
| use super::*; | ||
|
|
||
| // TODO: Kani reports as failing property "Only a single top-level call", which does not |
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.
This diff adds
#[requires(...)]attributes to the unsafe functions, translating the "SAFETY:" comments into code contracts. These contracts specify the preconditions that must be met for the function to be safely called.