docs: clarify unknown enum string deserialization behavior#5180
Closed
leno23 wants to merge 1 commit into
Closed
Conversation
Document that unrecognized strings map to the first SERIALIZE_ENUM pair rather than throwing, with pointer to nlohmann#3992.
nlohmann
reviewed
May 17, 2026
|
|
||
| - When using `get<ENUM_TYPE>()`, undefined JSON values will default to the first pair specified in your map. Select this | ||
| default pair carefully. | ||
| - **Unknown string values** that do not match any mapped string also deserialize to that same first pair—they do not |
Owner
|
I do not like AI-generated documentation. As the behavior of enum conversion will change once #5151 is merged, this PR can be closed. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Document that
NLOHMANN_JSON_SERIALIZE_ENUMmaps unrecognized JSON strings to the first macro pair (current behavior) rather than throwingtype_error, and point readers to #3992 for stricter alternatives.Motivation
Addresses confusion raised in #3992 without changing runtime behavior while strict-macro proposals are discussed.
Test plan
Made with Cursor