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

New options for encoding Go strings to and from CBOR byte strings #465

Merged
merged 3 commits into from
Jan 9, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Jan 5, 2024

Description

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 [email protected]
  • 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.

@benluddy benluddy force-pushed the go-string-as-cbor-byte-string branch from 9edd914 to 5af0d26 Compare January 5, 2024 20:56
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.

This is great! 👍 Thanks for adding this useful feature and also for optimizing byte string decoding while at it!

I left some minor suggestions about naming conventions used by existing options, etc.

encode.go Outdated Show resolved Hide resolved
encode.go Outdated
Comment on lines 351 to 352
// StringType specifies which CBOR string major type to use when encoding Go strings.
StringType StringType
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
// StringType specifies which CBOR string major type to use when encoding Go strings.
StringType StringType
// String specifies which CBOR type to use when encoding Go strings.
// - CBOR text string (major type 3) is default
// - CBOR byte string (major type 2)
String StringMode

decode.go Outdated Show resolved Hide resolved
decode.go Outdated Show resolved Hide resolved
decode.go Outdated Show resolved Hide resolved
decode.go Show resolved Hide resolved
decode.go Show resolved Hide resolved
The StringType encode option supports use cases that must not produce invalid CBOR (even if
well-formed) and must be able to encode Go strings that do not contain valid UTF-8 sequences,
without the overhead of sanitizing all input Go values. The default value of the option is
TextStringType and encodes Go strings to CBOR major type 3, which is identical to the preexisting
behavior.

Signed-off-by: Ben Luddy <[email protected]>
The unchanged default behavior is to produce an UnmarshalTypeError when decoding a CBOR byte string
into a Go string.

Signed-off-by: Ben Luddy <[email protected]>
@benluddy benluddy force-pushed the go-string-as-cbor-byte-string branch from 5af0d26 to ae20110 Compare January 8, 2024 21:24
@benluddy
Copy link
Contributor Author

benluddy commented Jan 8, 2024

Thanks @fxamacker, I've implemented all of your suggestions. Please take another look!

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! 👍 Thanks again for this PR!

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.

2 participants