[discuss] Jmcarp/enum interfaces #342
Draft
+776
−22
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.
Note: just a draft submitted for discussion, although we could clean this up and ship it pretty easily if we like the direction.
Problem: for oneOf types with object variants, we represent the set of variables as an
anyin the sdk. This means we don't get type safety when we unmarshal responses, and users have to cast, check errors, or marshal and unmarshal json to get typed values.Proposal: represent enums with object variants as interfaces. Each enum is represented by its own interface, and each variant is a struct that implements the interface using a private
is{{.Interface}}method. We generate a custom UnmarshalJSON method for each enum type to switch on its discriminator field (often "type", "kind", etc.) and unmarshal into the correct concrete type.If we like this direction, we can also add helper functions like
.As{{.ConcreteType}}to cast to concrete types.Part of #340.