Mark newtype wrappers as #[serde(transparent)]
#724
Merged
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.
In JSON, the difference between a newtype that's transparent or not is unobservable--they both render to the same serialized output. This is not true of other serializations and--more critically--not true of other implementations of
serde::Serializer
.In particular, I encountered this in oxidecomputer/progenitor#1017 where I observed that the
serde_urlencoded::Serializer
freaks out about our newtype wrappers. Perhaps this freak out is reasonable because the intended representation matches with the intention oftransparent
.Consider the case where I noticed this:
struct Name(String)
.Name
wraps a String and imposes constraints on it. It deserializes from a string and its intended serialization is a string--the newtype wrapper is purely a type for enforcing constraints when creating or manipulating the type. This hasn't bit us before, but marking these newtypes as transparent seems like the right thing to do.