Use encoding.TextMarshaler for string-valued types - #567
Open
felix-kaestner wants to merge 1 commit into
Open
felix-kaestner wants to merge 1 commit into
felix-kaestner wants to merge 1 commit into
Conversation
Replace json.Marshaler/json.Unmarshaler with the encoding package TextMarshaler/TextUnmarshaler interfaces on provider types that serialize as a plain string value. TextMarshaler is more semantically correct for these types: json.Marshaler declares "I can be any JSON value" (object, array, number), while TextMarshaler declares "I am a string" which matches what these types actually are. encoding/json calls MarshalText/UnmarshalText automatically, so JSON encoding continues to work unchanged. Additionally, the text interfaces are recognized by other encoders (YAML, XML, CSV), making the types usable in more contexts. UnmarshalText receives the raw string bytes with JSON quotes already stripped, removing the need to json.Unmarshal into an intermediate string variable first. Signed-off-by: Felix Kästner <felix.kaestner@sap.com>
felix-kaestner
force-pushed
the
encoding-text
branch
from
September 16, 2026 16:05
91177aa to
afd6268
Compare
Merging this branch changes the coverage (1 decrease, 2 increase)
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. |
hardikdr
added
the
area/switch-automation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Replace json.Marshaler/json.Unmarshaler with the encoding package TextMarshaler/TextUnmarshaler interfaces on provider types that serialize as a plain string value.
TextMarshaler is more semantically correct for these types: json.Marshaler declares "I can be any JSON value" (object, array, number), while TextMarshaler declares "I am a string" which matches what these types actually are.
encoding/json calls MarshalText/UnmarshalText automatically, so JSON encoding continues to work unchanged. Additionally, the text interfaces are recognized by other encoders (YAML, XML, CSV), making the types usable in more contexts.
UnmarshalText receives the raw string bytes with JSON quotes already stripped, removing the need to json.Unmarshal into an intermediate string variable first.