test(model): bitflags static assertions + serde#2088
Merged
spring4175 merged 2 commits intomainfrom Jan 28, 2023
Merged
Conversation
Add static assertions for bitflag implementations and constant values, as well as tests for the serde implementations. The serde tests include a test for the (de)serialization of a variant and that unknown bits are truncated on deserialization.
github-actions
bot
added
c-model
spring4175
added a commit
that referenced
this pull request
Jan 25, 2023
Bitflags received from the Discord API are truncated when deserialized. However, we have recently taken a model of accepting "unknown information", with our recent reworks of enums the shining example. Instead of failing to deserialize / ignore "unknown variants" we have taken the step to treat unknown data as "first class", in that Twilight not necessarily registering known values is okay and users can manually handle variants as they need. We should apply the same logic to bitflags and not trim unknown data. This unfortunately makes use of unsafe code for constructing bitflags in tests, because `bitflags` has an unorthodox definition of what "unsafe" is for its `Bitflags::from_bits_unchecked` function. `bitflags` treats unknown bits as being "unsafe", and so the function to construct bitflags with possibly unknown variants is unsafe. I have added notes detailing this. This is a breaking change because unknown bits are no longer truncated. Blocks on PR #2088.
7596ff
approved these changes
Jan 27, 2023
Erk-
approved these changes
Jan 28, 2023
Member
Erk-
left a comment
Erk-
left a comment
There was a problem hiding this comment.
This may be a rare case where I think we could make this better by using a macro to construct the assert_impl_all, to ensure that all are updated if we do it one place, but I think that is outside the general scope of this pr and can be done later
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
3 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.
Add static assertions for bitflag implementations and constant values, as well as tests for the serde implementations. The serde tests include a test for the (de)serialization of a variant and that unknown bits are truncated on deserialization.