Json::Reader Class Reference

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

#include <reader.h>

List of all members.

Classes

class  ErrorInfo
class  Token

Public Types

typedef char Char
typedef const CharLocation

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.
JSONCPP_DEPRECATED("Use
getFormattedErrorMessages
instead") std 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.


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

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

Parse from input stream.

See also:
Json::operator>>(std::istream&, Json::Value&).
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.

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.

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