Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options to support byte string map keys as struct field names #472

Merged
merged 2 commits into from Jan 23, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Jan 18, 2024

Description

Introduces one encode option and one decode option to control the CBOR major type of struct field names.

The current behavior on encode is to produce text strings for field names, unless a field has the keyasint tag option, in which case it will serialize as either a positive or negative CBOR int. That remains the default encode behavior, with the new option to produce byte strings instead of text strings for fields that do not have the keyasint tag option.

Decoding a CBOR map containing a byte string key into a Go struct value currently produces an error. By overriding the default value of the new decode option, byte string map keys can also be recognized as struct field names.

PR Was Proposed and Welcomed in Currently Open Issue

Checklist (for code PR only, ignore for docs PR)

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all 18 ci linters (golint, gosec, staticcheck, etc.)
  • Sign each commit with your real name and email.
    Last line of each commit message should be in this format:
    Signed-off-by: Firstname Lastname firstname.lastname@example.com
  • Certify the Developer's Certificate of Origin 1.1
    (see next section).

Certify the Developer's Certificate of Origin 1.1

  • By marking this item as completed, I certify
    the Developer Certificate of Origin 1.1.
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Signed-off-by: Ben Luddy <bluddy@redhat.com>
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 👍 Thanks for opening this PR!

I left a couple of comments (one is my fault about naming option) and a small optimization is possible.

Thanks again!

encode.go Outdated Show resolved Hide resolved
cache.go Outdated Show resolved Hide resolved
Signed-off-by: Ben Luddy <bluddy@redhat.com>
@benluddy
Copy link
Contributor Author

Thanks for the feedback, @fxamacker! I applied both of your suggestions.

Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍 Many thanks!

@fxamacker fxamacker merged commit 23ec2c5 into fxamacker:master Jan 23, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants