Json::Reader Class Reference

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

#include <json/reader.h>

Classes
class	ErrorInfo
class	Token

Public Types
typedef char	Char
typedef const Char *	Location

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 (std::istream &is, Value &root, bool collectComments=true)
	Parse from input stream.
std::string	getFormatedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document.
std::string	getFormattedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document.

Detailed Description

Unserialize a JSON document into a Value.

Definition at line 23 of file reader.h.

Member Typedef Documentation

typedef char Json::Reader::Char

Definition at line 26 of file reader.h.

typedef const Char* Json::Reader::Location

Definition at line 27 of file reader.h.

Constructor & Destructor Documentation

Json::Reader::Reader

(

)

Constructs a Reader allowing all features for parsing.

Definition at line 81 of file json_reader.cpp.

Json::Reader::Reader

(

const Features &

features

)

Constructs a Reader allowing the specified feature set for parsing.

Definition at line 87 of file json_reader.cpp.

Member Function Documentation

std::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).

Definition at line 846 of file json_reader.cpp.

References getFormattedErrorMessages().

std::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.

Definition at line 853 of file json_reader.cpp.

Referenced by getFormatedErrorMessages(), and Json::operator>>().

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.

Definition at line 94 of file json_reader.cpp.

Referenced by Json::operator>>(), and parse().

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.

Definition at line 123 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	(	std::istream &	is,
		Value &	root,
		bool	collectComments = true
	)

Parse from input stream.

See Also

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

Definition at line 106 of file json_reader.cpp.

References parse().

---

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

• include/json/reader.h
• src/lib_json/json_reader.cpp