Make GraphicsContext::window_mut() an unsafe fn.
#5
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
As documented in the new safety comment, providing `&mut` access to an inner component about which there are consistency invariants is unsafe, because `&mut` is sufficient for a caller to completely replace the value (using assignment or `std::mem::swap()`). Luckily, when `softbuffer` is used with `winit`, no `&mut` access is needed. However, other windowing libraries such as `glfw` and `sdl2` do have `&mut` methods, so this method can't simply be removed. This is a breaking change since it makes a previously safe function unsafe, and should not be published without a major version bump (i.e. to `0.2.0` or higher).
john01dav
approved these changes
Aug 24, 2022
|
Sorry for the delay. I had some employment contract issues with FOSS contributions, and they are now resolved. |
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.
As documented in the new safety comment, providing
&mutaccess to an inner component about which there are consistency invariants is unsafe, because&mutis sufficient for a caller to completely replace the value (using assignment orstd::mem::swap()).Luckily, when
softbufferis used withwinit, no&mutaccess is needed. However, other windowing libraries such assdl2do have&mutmethods, so this method can't simply be removed. (I don't know which windowing libraries would in fact be compatible with softbuffer and thus relevant.)This is a breaking change since it makes a previously safe function unsafe, and should not be published without a major version bump (i.e. to
0.2.0or higher).