Medical Imaging Interaction Toolkit  2018.4.99-ef453c4b
Medical Imaging Interaction Toolkit
Json::Reader Class Reference

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

#include <jsoncpp.h>

Public Types

typedef char Char
 
typedef const CharLocation
 

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

Detailed Description

Unserialize a JSON document into a Value.

Definition at line 1455 of file jsoncpp.h.

Member Typedef Documentation

◆ Char

typedef char Json::Reader::Char

Definition at line 1458 of file jsoncpp.h.

◆ Location

typedef const Char* Json::Reader::Location

Definition at line 1459 of file jsoncpp.h.

Constructor & Destructor Documentation

◆ Reader() [1/2]

Json::Reader::Reader ( )

Constructs a Reader allowing all features for parsing.

Definition at line 270 of file jsoncpp.cpp.

◆ Reader() [2/2]

Json::Reader::Reader ( const Features features)

Constructs a Reader allowing the specified feature set for parsing.

Definition at line 276 of file jsoncpp.cpp.

Member Function Documentation

◆ getFormatedErrorMessages()

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 1035 of file jsoncpp.cpp.

References getFormattedErrorMessages().

◆ 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 1042 of file jsoncpp.cpp.

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

◆ parse() [1/3]

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

Read a Value from a JSON document.

Parameters
documentUTF-8 encoded string containing the document to read.
root[out] Contains the root value of the document if it was successfully parsed.
collectCommentstrue 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 283 of file jsoncpp.cpp.

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

◆ parse() [2/3]

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

Read a Value from a JSON document.

Parameters
beginDocPointer on the beginning of the UTF-8 encoded string of the document to read.
endDocPointer 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.
collectCommentstrue 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 312 of file jsoncpp.cpp.

References Json::Features::allowComments_, Json::arrayValue, Json::codePointToUTF8(), Json::commentAfter, Json::commentAfterOnSameLine, Json::commentBefore, Json::containsNewLine(), Json::in(), info(), Json::Value::isArray(), Json::Value::isObject(), line, Json::Value::maxInt, Json::Value::maxLargestUInt, Json::Value::minLargestInt, Json::objectValue, Json::Value::setComment(), and Json::Features::strictRoot_.

◆ parse() [3/3]

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 295 of file jsoncpp.cpp.

References parse().


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