Add safety documentation #2344
Open
Add safety documentation #2344
+15
−0
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
|
I guess the part where we say "pointer is required to be non-null can be covered by simply utilizing the |
chipshort
reviewed
Jan 21, 2025
| /// | ||
| /// This function requires the following invariants to be upheld: | ||
| /// - `capacity` is smaller or equal to `length` | ||
| /// - The number of bytes allocated by the pointer must be equal to `capacity` |
There was a problem hiding this comment.
This one is only the case for Region<Owned>, right? Because a slice does not uphold this.
| /// - `capacity` is smaller or equal to `length` | ||
| /// - The number of bytes allocated by the pointer must be equal to `capacity` | ||
| /// - The byte range covered by `length` must be initialized | ||
| /// - `ptr` is a non-dangling and non-null pointer |
There was a problem hiding this comment.
What do we need the non-dangling part for? I'm pretty sure vec![].as_ptr() creates a dangling pointer
Co-authored-by: Christoph Otter <[email protected]>
That sounds nice. I'm always a fan of enforcing correct usage through the type system where possible. |
Co-authored-by: Christoph Otter <[email protected]>
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.
Closes #2305
I hope this documentation makes it a little clearer why the usage here is sound.
Best proof-read by someone that isn't me to make sure what I wrote is actually coherent for others.