Unserialize a JSON document into a Value. More...
#include <json/reader.h>
 Collaboration diagram for Json::Reader:
 Collaboration diagram for Json::Reader:| Classes | |
| struct | StructuredError | 
| An error tagged with where in the JSON text it was encountered.  More... | |
| Public Types | |
| using | Char = char | 
| using | Location = const Char* | 
| Public Member Functions | |
| Reader () | |
| Constructs a Reader allowing all features for parsing. | |
| Reader (const Features &features) | |
| Constructs a Reader allowing the specified feature set for parsing. | |
| bool | parse (const std::string &document, Value &root, bool collectComments=true) | 
| Read a Value from a JSON document. | |
| bool | parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true) | 
| Read a Value from a JSON document. | |
| bool | parse (IStream &is, Value &root, bool collectComments=true) | 
| Parse from input stream. | |
| __declspec (deprecated("Use getFormattedErrorMessages() instead.")) String getFormatedErrorMessages() const | |
| Returns a user friendly string that list errors in the parsed document. | |
| String | getFormattedErrorMessages () const | 
| Returns a user friendly string that list errors in the parsed document. | |
| std::vector< StructuredError > | getStructuredErrors () const | 
| Returns a vector of structured errors encountered while parsing. | |
| bool | pushError (const Value &value, const String &message) | 
| Add a semantic error message. | |
| bool | pushError (const Value &value, const String &message, const Value &extra) | 
| Add a semantic error message with extra context. | |
| bool | good () const | 
| Return whether there are any errors. | |
Unserialize a JSON document into a Value.
| using Json::Reader::Char = char | 
| using Json::Reader::Location = const Char* | 
| Json::Reader::Reader | ( | ) | 
Constructs a Reader allowing all features for parsing.
Definition at line 88 of file json_reader.cpp.
| Json::Reader::Reader | ( | const Features & | features | ) | 
Constructs a Reader allowing the specified feature set for parsing.
Definition at line 90 of file json_reader.cpp.
| Json::Reader::__declspec | ( | deprecated("Use getFormattedErrorMessages() instead.") | ) | const | 
Returns a user friendly string that list errors in the parsed document.
| String Json::Reader::getFormattedErrorMessages | ( | ) | const | 
Returns a user friendly string that list errors in the parsed document.
Definition at line 790 of file json_reader.cpp.
| std::vector< Reader::StructuredError > Json::Reader::getStructuredErrors | ( | ) | const | 
Returns a vector of structured errors encountered while parsing.
Definition at line 803 of file json_reader.cpp.
References Json::Reader::StructuredError::message, Json::Reader::StructuredError::offset_limit, and Json::Reader::StructuredError::offset_start.
| bool Json::Reader::good | ( | ) | const | 
Return whether there are any errors.
true if there are no errors to report false if errors have occurred. Definition at line 849 of file json_reader.cpp.
| bool Json::Reader::parse | ( | const char * | beginDoc, | 
| const char * | endDoc, | ||
| Value & | root, | ||
| bool | collectComments = true ) | 
Read a Value from a JSON document.
| beginDoc | Pointer on the beginning of the UTF-8 encoded string of the document to read. | |
| endDoc | Pointer on the end of the UTF-8 encoded string of the document to read. Must be >= beginDoc. | |
| [out] | root | Contains the root value of the document if it was successfully parsed. | 
| collectComments | trueto collect comment and allow writing them back during serialization,falseto discard comments. This parameter is ignored if Features::allowComments_ isfalse. | 
true if the document was successfully parsed, false if an error occurred. Definition at line 112 of file json_reader.cpp.
References Json::Features::allowComments_, Json::commentAfter, Json::Value::isArray(), Json::Value::isObject(), Json::Value::setComment(), and Json::Features::strictRoot_.
| bool Json::Reader::parse | ( | const std::string & | document, | 
| Value & | root, | ||
| bool | collectComments = true ) | 
Read a Value from a JSON document.
| document | UTF-8 encoded string containing the document to read. | |
| [out] | root | Contains the root value of the document if it was successfully parsed. | 
| collectComments | trueto collect comment and allow writing them back during serialization,falseto discard comments. This parameter is ignored if Features::allowComments_ isfalse. | 
true if the document was successfully parsed, false if an error occurred. Definition at line 92 of file json_reader.cpp.
References parse().
Referenced by parse(), and parse().
 Here is the caller graph for this function:
 Here is the caller graph for this function:Add a semantic error message.
| value | JSON Value location associated with the error | 
| message | The error message. | 
true if the error was successfully added, false if the Value offset exceeds the document size. Definition at line 815 of file json_reader.cpp.
References Json::Value::getOffsetLimit(), and Json::Value::getOffsetStart().
Add a semantic error message with extra context.
| value | JSON Value location associated with the error | 
| message | The error message. | 
| extra | Additional JSON Value location to contextualize the error | 
true if the error was successfully added, false if either Value offset exceeds the document size. Definition at line 831 of file json_reader.cpp.
References Json::Value::getOffsetLimit(), and Json::Value::getOffsetStart().
 1.12.0
 1.12.0