Update README, add section on limitations, update TODO

This commit is contained in:
etwyniel
2019-11-18 16:28:01 +01:00
parent 85ef6579f3
commit 48352c270f

View File

@@ -57,6 +57,15 @@ assert_eq!(actual, expected);
More examples can be found in the [tests](https://github.com/etwyniel/miniserde-enum/tree/master/tests)
directory.
## Limitations
Deserializing internally tagged enums and adjacently tagged enums requires
the tag to be the first key in the object, otherwise from\_str will return
an error.
Additionally, not every enum representation is currently supported
(see [TODO](#TODO)).
## TODO
- Serialization:
@@ -66,9 +75,9 @@ directory.
- Adjacently tagged enums
- Deserialization
- ~~Externally tagged enums~~
- Internally tagged enums
- ~~Internally tagged enums~~
- Untagged enums
- Adjacently tagged enums
- ~~Adjacently tagged enums~~
<br>