The C++ framework for developing highly scalable, high performance servers on Windows platforms.

• Home
• What
• Why
• How
• Who
• Products
• Pricing
• Blog
• Contact

Search

Reader Class Reference

Collaboration diagram for Reader:

[legend]

List of all members.

---

Detailed Description

Unserialize a JSON document into a Value.

Deprecated:

Use CharReader and CharReaderBuilder.

Public Types
typedef char	Char
typedef const Char *	Location
Public Member Functions
	Reader ()
	Reader (const Features &features)
bool	parse (const std::string &document, Value &root, bool collectComments=true)
bool	parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true)
bool	parse (std::istream &is, Value &root, bool collectComments=true)
std::string	getFormatedErrorMessages () const
std::string	getFormattedErrorMessages () const
Classes
class	ErrorInfo
class	Token

---

Member Typedef Documentation

typedef char Char

typedef const Char* Location

---

Constructor & Destructor Documentation

Reader

(

)

Constructs a Reader allowing all features for parsing.

Reader

(

const Features &

features

)

Constructs a Reader allowing the specified feature set for parsing.

---

Member Function Documentation

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

Parse from input stream.

See also:

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

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

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

---