Document that NotNan is repr(transparent).#158
Merged
mbrubeck merged 2 commits intoreem:masterfrom Oct 15, 2024
Merged
Conversation
Currently, rustdoc only displays `repr(transparent)` if the type’s fields are public, so there is no indication in the documentation that `NotNan` has `repr(transparent)`. Even if it was visible, there is not currently a strong consensus that such a repr may be assumed to be a stable part of the public API. Therefore, add paragraphs to `NotNan` and `OrderedFloat`’s documentation guaranteeing the repr. I also mentioned `bytemuck` so as to not be encouraging unsafe code, though the phrasing isn’t great.
This gives a more strongly-typed way for users to take advantage of `OrderedFloat`’s representation.
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
2 participants
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.
Currently, rustdoc only displays
repr(transparent)if the type’s fields are public, so there is no indication in the documentation thatNotNanhasrepr(transparent). Even if it was visible, there is not currently a strong consensus that such a repr may be assumed to be a stable part of the public API.Therefore, I propose to add paragraphs to
NotNanandOrderedFloat’s documentation guaranteeing the repr. I also mentionedbytemuckso as to not be encouraging unsafe code, though the phrasing isn’t great.I’ve also added
impl bytemuck::TransparentWrapper for OrderedFloat, which simply gives another way for users to perform conversions, more strongly typed thanbytemuck’s casts to/from bytes.