Torque2D Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Classes | Public Types | Public Member Functions | List of all members
Reader Class Reference

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

`#include <reader.h>`

## 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 (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...

## Detailed Description

Unserialize a JSON document into a Value.

## 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

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.

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

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

Parse from input stream.

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

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

- persistence/rapidjson/thirdparty/jsoncpp/include/json/reader.h
- persistence/rapidjson/thirdparty/jsoncpp/src/lib_json/json_reader.cpp