add docs to describe the behavior of multi-bit flags#340
Merged
KodrAus merged 1 commit intobitflags:mainfrom Apr 17, 2023
Merged
add docs to describe the behavior of multi-bit flags#340KodrAus merged 1 commit intobitflags:mainfrom
KodrAus merged 1 commit intobitflags:mainfrom
Conversation
This clears up possible confusion about how a flag that defines multiple bits behaves when calling `from_bits` or `from_bits_truncate`. Those functions do not treat multi-bit flags as a set of possible bits that can be set, but rather as a unit where the bits must exactly match one of the defined flags.
KodrAus
approved these changes
Apr 17, 2023
Member
KodrAus
left a comment
There was a problem hiding this comment.
Thanks @nicholasbishop! This is a great clarification 🙇
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.
This clears up possible confusion about how a flag that defines multiple bits behaves when calling
from_bitsorfrom_bits_truncate. Those functions do not treat multi-bit flags as a set of possible bits that can be set, but rather as a unit where the bits must exactly match one of the defined flags.