Add a warning that flatten and deny_unknown_fields should not be mixed.
#120
Conversation
This file contains 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
dtolnay
requested changes
Jan 23, 2021
_src/field-attrs.md
Outdated
| @@ -38,6 +38,10 @@ | |||
| with arbitrary string keys. The [struct flattening](attr-flatten.md) page | |||
| provides some examples. | |||
|
|
|||
| *Note:* This attribute clashes with [`flatten`](attr-flatten.md) and might | |||
There was a problem hiding this comment.
If I am reading this correctly, this line says that flatten clashes with flatten. Clashing attributes is bad, but it's not quite that bad!
dtolnay
reviewed
Jan 23, 2021
_src/attr-flatten.md
Outdated
| @@ -5,6 +5,9 @@ The `flatten` attribute inlines keys from a field into the parent struct. | |||
| supported only within structs that have named fields, and the field to which it | |||
| is applied must be a struct or map type. | |||
|
|
|||
| *Note:* This attribute clashes with `flatten` and might make the struct | |||
There was a problem hiding this comment.
Same here -- this claims flatten clashes with flatten.
…mixed. There are various bug reports about the interaction of `flatten` and `deny_unknown_fields`. In the end they cannot really be combined, since flatten does not consume the fields thus `deny_unknown_fields` will error on them. serde-rs/serde#1957 serde-rs/serde#1600 serde-rs/serde#1547
|
@dtolnay Thank you for the comment. Yes I messed up the description while hastily creating this PR. I fixed the mistake. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There are various bug reports about the interaction of
flattenanddeny_unknown_fields. In the end they cannot really be combined, sinceflatten does not consume the fields thus
deny_unknown_fieldswill erroron them.
serde-rs/serde#1957
serde-rs/serde#1600
serde-rs/serde#1547
I'm happy to update the wording of the notice to include any suggestions.