Improve byte string format decoding options #550
Merged
Conversation
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
While at it, also improve docs.
Owner
Author
|
@x448 PTAL 🙏 |
Owner
Author
|
@benluddy PTAL 🙏 |
x448
approved these changes
Jun 9, 2024
| // ByteSliceExpectedEncodingMode specifies how to decode a byte string NOT enclosed in an "expected | ||
| // later encoding" tag (RFC 8949 Section 3.4.5.2) into a Go byte slice. | ||
| type ByteSliceExpectedEncodingMode int | ||
| // ByteStringExpectedFormatMode specifies how to decode CBOR byte string into Go byte slice |
Contributor
There was a problem hiding this comment.
Makes sense. The old suffix "EncodingMode" for a decoding mode name would have been confusing.
| name: "unsigned bignum content not enclosed in expected encoding tag", | ||
| tag: Tag{Number: tagNumUnsignedBignum, Content: []byte{0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}, | ||
| opts: EncOptions{ByteSlice: ByteSliceExpectedEncodingBase16}, | ||
| opts: EncOptions{ByteSlice: ByteSliceToByteStringWithExpectedConversionToBase16}, |
Contributor
There was a problem hiding this comment.
It wasn't named in this PR but ByteSliceToByteStringWithExpectedConversionToBase16 can be renamed to a shorter name.
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.
This PR improves unreleased decoding options to be included in v2.7.0.
Changes include:
Renamed
ByteSliceExpectedEncodingModetoByteStringExpectedFormatMode, also renamed related optionsRenamed
DecOptions.ByteSliceExpectedEncodingtoDecOptions.ByteStringExpectedFormatAdded
ByteStringExpectedFormatError, which is returned when decoding expected format failsUpdated comments to improve docs. For example,