Skip to content

Use TextUnmarshaler on byte strings with ByteStringToStringAllowed.#682

Merged
fxamacker merged 1 commit intofxamacker:masterfrom
benluddy:textunmarshaler-bytestringtostring
Jul 12, 2025
Merged

Use TextUnmarshaler on byte strings with ByteStringToStringAllowed.#682
fxamacker merged 1 commit intofxamacker:masterfrom
benluddy:textunmarshaler-bytestringtostring

Conversation

@benluddy
Copy link
Copy Markdown
Contributor

@benluddy benluddy commented Jul 11, 2025 •
edited
Loading

Description

Decode modes that allow unmarshaling CBOR byte strings into Go strings and recognize TextUnmarshalers should also allow unmarshaling CBOR byte strings into TextUnmarshalers. When interoperating with an encode mode that marshals Go strings to CBOR byte strings, this preserves roundtrippability of TextMarshaler -> CBOR text string -> Go string -> CBOR byte string -> TextUnmarshaler.

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 lint checks in CI (goimports, 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.

@benluddy
Use TextUnmarshaler on byte strings with ByteStringToStringAllowed.
9bdebd2 
Decode modes that allow unmarshaling CBOR byte strings into Go strings and recognize
TextUnmarshalers should also allow unmarshaling CBOR byte strings into TextUnmarshalers. When
interoperating with an encode mode that marshals Go strings to CBOR byte strings, this preserves
roundtrippability of TextMarshaler -> CBOR text string -> Go string -> CBOR byte string ->
TextUnmarshaler.

Signed-off-by: Ben Luddy <bluddy@redhat.com>
@benluddy benluddy force-pushed the textunmarshaler-bytestringtostring branch from 3b0e023 to 9bdebd2 Compare July 11, 2025 17:20
fxamacker
fxamacker approved these changes Jul 12, 2025
View reviewed changes
Copy link
Copy Markdown
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.

@benluddy Thanks for catching and fixing this before release!

@fxamacker fxamacker merged commit 8c8d4c3 into fxamacker:master Jul 12, 2025
20 checks passed
This was referenced Jul 13, 2025
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fxamacker fxamacker fxamacker approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@benluddy @fxamacker