Add documentation for variant_identifier and field_identifier
#146
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
srid
reviewed
Aug 16, 2023
Comment on lines
+59
to
+61
| - ##### `#[serde(field_identifier)]` {#field--identifier} | ||
|
|
||
| Identical to [`variant_identifier`](#variant--identifier), but also allows for the last variant to be a newtype variant, which will be used if none of the other variants match (similar to [`#[serde(other)]`](../variant-attrs.html#other)). Like `variant_identifier`, this forces the enum to always be represented as a string, regardless of the underlying data format's representation of enums. |
There was a problem hiding this comment.
Could we have an example here?
It doesn't seem to work based on the description:
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", field_identifier)]
pub enum Type {
NixosModule,
Derivation,
App,
Unknown(String),
}
There was a problem hiding this comment.
Okay, so when using this condition, Serialize cannot be derive automatically. That should be mentioned, although I wonder why this limitation even exists.
There was a problem hiding this comment.
Oh, that's a good catch. Probably it was only intended to support the intermediary enum types used during deserialization, so there was never a need to add serialize support. That's something I can look into adding in parallel with this docs PR.
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.
This PR adds documentation for the
variant_identifierandfield_identifierattributes on enums. I think this should be alright to make officially part of the public API, since they're mentioned in existing documentation, but I'm happy to be wrong about this.Fixes serde-rs/serde#1238