Json::Reader Class Reference

Unserialize a JSON document into a Value. More...

#include <json.h>

Data Structures
struct	StructuredError
	An error tagged with where in the JSON text it was encountered. More...

Public Types
typedef char	Char
typedef const Char *	Location

Public Member Functions
	Reader ()
	Constructs a Reader allowing all features for parsing. More...
	Reader (const Features &features)
	Constructs a Reader allowing the specified feature set for parsing. More...
bool	parse (const std::string &document, Value &root, bool collectComments=true)
	Read a Value from a JSON document. More...
bool	parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true)
	Read a Value from a JSON document. More...
bool	parse (IStream &is, Value &root, bool collectComments=true)
	Parse from input stream. More...
String	getFormatedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document. More...
String	getFormattedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document. More...
std::vector< StructuredError >	getStructuredErrors () const
	Returns a vector of structured erros encounted while parsing. More...
bool	pushError (const Value &value, const String &message)
	Add a semantic error message. More...
bool	pushError (const Value &value, const String &message, const Value &extra)
	Add a semantic error message with extra context. More...
bool	good () const
	Return whether there are any errors. More...

Detailed Description

Unserialize a JSON document into a Value.

Deprecated:

Use CharReader and CharReaderBuilder.

Member Typedef Documentation

typedef char Json::Reader::Char

typedef const Char* Json::Reader::Location

Constructor & Destructor Documentation

Json::Reader::Reader

(

)

Constructs a Reader allowing all features for parsing.

Json::Reader::Reader

(

const Features &

features

)

Constructs a Reader allowing the specified feature set for parsing.

Member Function Documentation

String Json::Reader::getFormatedErrorMessages

(

)

const

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Deprecated:

Use getFormattedErrorMessages() instead (typo fix).

String Json::Reader::getFormattedErrorMessages

(

)

const

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

std::vector< Reader::StructuredError > Json::Reader::getStructuredErrors

(

)

const

Returns a vector of structured erros encounted while parsing.

Returns

A (possibly empty) vector of StructuredError objects. Currently only one error can be returned, but the caller should tolerate multiple errors. This can occur if the parser recovers from a non-fatal parse error and then encounters additional errors.

bool Json::Reader::good

(

)

const

Return whether there are any errors.

Returns

true if there are no errors to report false if errors have occurred.

bool Json::Reader::parse	(	const std::string &	document,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

bool Json::Reader::parse	(	const char *	beginDoc,
		const char *	endDoc,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters

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.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

bool Json::Reader::parse	(	IStream &	is,
		Value &	root,
		bool	collectComments = true
	)

Parse from input stream.

See also

Json::operator>>(std::istream&, Json::Value&).

bool Json::Reader::pushError	(	const Value &	value,
		const String &	message
	)

Add a semantic error message.

Parameters

value	JSON Value location associated with the error
message	The error message.

Returns

true if the error was successfully added, false if the Value offset exceeds the document size.

bool Json::Reader::pushError	(	const Value &	value,
		const String &	message,
		const Value &	extra
	)

Add a semantic error message with extra context.

Parameters

value	JSON Value location associated with the error
message	The error message.
extra	Additional JSON Value location to contextualize the error

Returns

true if the error was successfully added, false if either Value offset exceeds the document size.

---

The documentation for this class was generated from the following files:

• include/jsoncpp/json/json.h
• src/jsoncpp.cpp