Updated WeePickle readme.md around Defaults, Options, @dropDefault, and Null Handling #79
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
…in repos + Overhauled Defaults, Options, @dropDefault, and Null Handling. Condensed sections, then expanded examples to show typical use cases. + some consistency tweaks, minor corrections
htmldoug
reviewed
Jun 17, 2021
| ``` | ||
|
|
||
| If attempting to deserialize JSON to a field that has no defaults, and the JSON value is invalid (e.g. missing, or `null`), the operation will throw an Abort Exception. |
htmldoug
reviewed
Jun 17, 2021
| case class Maybe1(i: Option[Int]) | ||
| object Maybe1 { | ||
| implicit val rw: FromTo[Maybe1] = macroFromTo | ||
| case class DfltOpt(i: Option[Int]) // equivalent to 'i: Option[Int] = None` for weepickling |
htmldoug
reviewed
Jun 17, 2021
| So putting `@dropDefault` at the class level will apply to all `Option` types in the class, whether a default is provided explicitly or not. | ||
| ### Explicit Defaults | ||
|
|
||
| An `Option` will have an [implicit default of `None`](#Nones-&-Nulls), unless you provide an explicit default ([Defaults](#Defaults)): |
htmldoug
reviewed
Jun 17, 2021
|
|
||
| ### Option Defaults | ||
|
|
||
| `Option` works the same way, except there is always an assumed implicit `None` default, if an explicit default is not provided. See [Option Defaults & Nulls](#Option-Defaults-&-Nulls). |
htmldoug
reviewed
Jun 17, 2021
| @@ -115,81 +115,184 @@ Case classes are serialized using the `apply` and `unapply` methods on their com | |||
| Anything else is not supported by default, but you can add support using Custom Picklers. | |||
|
|
|||
| ## Defaults | |||
| If a field is missing upon deserialization, weePickle uses the default value if one exists. | |||
| If a field is missing upon **deserialization**, weePickle uses the default value if one exists: | |||
There was a problem hiding this comment.
I know deserialization and serialization were already here, but they're a bit misleading. All of these behaviors have to do with case classes rather than serialization formats. For example, you can do FromJson("{}").transform(ToMsgPack.string), which is both deserialization and serialization, but none of this will apply.
More README surgery would be welcome if interested. Also, totally fine to leave for a separate PR.
htmldoug
reviewed
Jun 17, 2021
htmldoug
approved these changes
Jun 17, 2021
jducoeur
approved these changes
Jun 17, 2021
Co-authored-by: Doug Roper <[email protected]>
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.
TODO