From 48352c270f9a96bf6e98131cdeabf2bd8735d86d Mon Sep 17 00:00:00 2001 From: etwyniel Date: Mon, 18 Nov 2019 16:28:01 +0100 Subject: [PATCH] Update README, add section on limitations, update TODO --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e5353ba..3ea6369 100644 --- a/README.md +++ b/README.md @@ -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~~