Document that len
does not include skipped struct fields
#2714
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.
At least this seems to be how serde_derive behaves:
serde/serde_derive/src/ser.rs
Lines 335 to 341 in 3f43fca
Explicitly documenting this makes it easier for custom
Serializer
implementations to know what to expect from thelen
value, and makes it clearer for customSerialize
implementations to know what to provide as value.