Add derive Decode
for transparent enums
#14
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.
Summary
Adds support for deriving
ssz::Decode
on#[ssz(enum_behaviour = "transparent")]
enums by attempting to decode all variants in order until one is successful. Returnsssz::DecodeError::NoMatchingVariant
if none can be successfully decoded. This is the same approach used by serde for their untagged enum representation.Motivation
This is useful in situations where we are expecting one of a few distinctly decodable types.
Considerations
In some cases, the ordering of the enum variants will matter and this may not always be obvious to the user. The user must be careful not to include a variant that will "shadow" subsequent variants. It would be ideal to warn/panic in these cases. (Is this possible?)