docs: clarify Invalid Variant documentation and usage - #231
Open
AdamMagued wants to merge 1 commit into
Open
AdamMagued wants to merge 1 commit into
AdamMagued wants to merge 1 commit into
Conversation
Any valid 128-bit UUID classifies into RFC4122, Reserved, Microsoft, or Future. Variant never returns Invalid on a 16-byte UUID; Invalid represents an uninitialized or non-UUID sentinel. Update documentation for Variant, the variant constants, and (UUID).Variant to make this explicit. Additionally, document the invalid cases in unit test tables where parsing returns an error, and add an explicit test verifying Variant.String() returns "Invalid" for Variant(0) / Invalid. Fixes google#91
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
1 participant
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.
Summary
Any valid 128-bit UUID classifies into RFC4122, Reserved, Microsoft, or Future. Because all 256 byte patterns for byte 8 fall into one of those four branches, (UUID).Variant() never returns Invalid for a 16-byte UUID; Invalid represents an uninitialized or non-UUID sentinel.
Changes
Fixes #91