fxamacker / cbor

CBOR codec (RFC 8949) with CBOR tags, Go struct tags (toarray, keyasint, omitempty), float64/32/16, big.Int, and fuzz tested billions of execs.
MIT License
748 stars 61 forks source link

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

Closed benluddy closed 10 months ago

benluddy commented 10 months ago

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)

Certify the Developer's 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.
benluddy commented 10 months ago

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