Document return value of parse() when allow_exceptions == false and parsing fails

[ibc]

The parse() function says:

allow_exceptions: whether to throw exceptions in case of a parse error (optional, true by default)

What happens if allow_exceptions is set to false and parsing fails (due to incorrect JSON string)? How is the returned basic_json? Is it something that can be checked with json::type() == json::value_t::null?

[nlohmann]

You are right - the return value is not properly documented in this case. If allow_exceptions is false, then a discarded value is returned that can be checked with is_discarded(). Here is an example:

#include "json.hpp"
#include <iostream>

using json = nlohmann::json;

int main() {
    json j = json::parse("{]", nullptr, false);
    std::cout << "failure: " << std::boolalpha << j.is_discarded() << std::endl;
}

Output:

failure: true

I shall update the documentation accordingly.

[ibc]

Clear, thanks.