-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Correctly document is_null CTFE behavior. #134325
base: master
Are you sure you want to change the base?
Conversation
The "panic in const if CTFE doesn't know the answer" behavior was discussed to be the desired behavior in rust-lang#74939, and is currently how the function actually behaves. I intentionally wrote this documentation to allow for the possibility that a panic might not occur even if the pointer is out of bounds, because of rust-lang#133700 and other potential changes in the future.
Cc @RalfJung |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small wording nit. However I feel like this is also unnecessarily wordy, it kind of says the same thing (might panic for OOB pointers) twice in two paragraphs.
/// | ||
/// This inability to determine nullness occurs because there is no way for | ||
/// CTFE to know the absolute position of that memory, so it might or might | ||
/// not be possible to determine whether an offset out of bounds happens to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// not be possible to determine whether an offset out of bounds happens to | |
/// not be possible to determine whether an out-of-bounds offset happens to |
r? @RalfJung |
The "panic in const if CTFE doesn't know the answer" behavior was discussed to be the desired behavior in #74939, and is currently how the function actually behaves.
I intentionally wrote this documentation to allow for the possibility that a panic might not occur even if the pointer is out of bounds, because of #133700 and other potential changes in the future.