Json::CharReaderBuilder Class Reference

Build a CharReader implementation. More...

#include <json/reader.h>

Inherits Json::CharReader::Factory.

Public Member Functions
	CharReaderBuilder ()
	~CharReaderBuilder () override
CharReader *	newCharReader () const override
	Allocate a CharReader via operator new(). More...
bool	validate (Json::Value *invalid) const
Value &	operator[] (const String &key)
	A simple way to update a specific setting. More...
Public Member Functions inherited from Json::CharReader::Factory
virtual	~Factory ()=default

Static Public Member Functions
static void	setDefaults (Json::Value *settings)
	Called by ctor, but you can use this to reset settings_. More...
static void	strictMode (Json::Value *settings)
	Same as old Features::strictMode(). More...

Public Attributes
Json::Value	settings_
	Configuration of this builder. More...

Detailed Description

Build a CharReader implementation.

Usage:

using namespace Json;
CharReaderBuilder builder;
builder["collectComments"] = false;
Value value;
String errs;
bool ok = parseFromStream(builder, std::cin, &value, &errs);

Constructor & Destructor Documentation

CharReaderBuilder()

Json::CharReaderBuilder::CharReaderBuilder

(

)

~CharReaderBuilder()

Json::CharReaderBuilder::~CharReaderBuilder ( )

overridedefault

Member Function Documentation

newCharReader()

CharReader * Json::CharReaderBuilder::newCharReader ( ) const

overridevirtual

Allocate a CharReader via operator new().

Exceptions

std::exception

if something goes wrong (e.g. invalid settings)

Implements Json::CharReader::Factory.

operator[]()

Value & Json::CharReaderBuilder::operator[]

(

const String &

key

)

A simple way to update a specific setting.

setDefaults()

void Json::CharReaderBuilder::setDefaults ( Json::Value *  settings )

static

Called by ctor, but you can use this to reset settings_.

Precondition

'settings' != NULL (but Json::null is fine)

Remarks

Defaults:

  (*settings)["collectComments"] = true;
  (*settings)["allowComments"] = true;
  (*settings)["allowTrailingCommas"] = true;
  (*settings)["strictRoot"] = false;
  (*settings)["allowDroppedNullPlaceholders"] = false;
  (*settings)["allowNumericKeys"] = false;
  (*settings)["allowSingleQuotes"] = false;
  (*settings)["stackLimit"] = 1000;
  (*settings)["failIfExtra"] = false;
  (*settings)["rejectDupKeys"] = false;
  (*settings)["allowSpecialFloats"] = false;
  (*settings)["skipBom"] = true;

[CharReaderBuilderDefaults]

[CharReaderBuilderDefaults]

strictMode()

void Json::CharReaderBuilder::strictMode ( Json::Value *  settings )

static

Same as old Features::strictMode().

Precondition

'settings' != NULL (but Json::null is fine)

Remarks

Defaults:

  (*settings)["allowComments"] = false;
  (*settings)["allowTrailingCommas"] = false;
  (*settings)["strictRoot"] = true;
  (*settings)["allowDroppedNullPlaceholders"] = false;
  (*settings)["allowNumericKeys"] = false;
  (*settings)["allowSingleQuotes"] = false;
  (*settings)["stackLimit"] = 1000;
  (*settings)["failIfExtra"] = true;
  (*settings)["rejectDupKeys"] = true;
  (*settings)["allowSpecialFloats"] = false;
  (*settings)["skipBom"] = true;

[CharReaderBuilderStrictMode]

[CharReaderBuilderStrictMode]

validate()

bool Json::CharReaderBuilder::validate

(

Json::Value *

invalid

)

const

Returns

true if 'settings' are legal and consistent; otherwise, indicate bad settings via 'invalid'.

Member Data Documentation

settings_

Json::Value Json::CharReaderBuilder::settings_

Configuration of this builder.

These are case-sensitive. Available settings (case-sensitive):

• "collectComments": false or true
  • true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if allowComments is false.
• "allowComments": false or true
  • true if comments are allowed.
• "allowTrailingCommas": false or true
  • true if trailing commas in objects and arrays are allowed.
• "strictRoot": false or true
  • true if root must be either an array or an object value
• "allowDroppedNullPlaceholders": false or true
  • true if dropped null placeholders are allowed. (See StreamWriterBuilder.)
• "allowNumericKeys": false or true
  • true if numeric object keys are allowed.
• "allowSingleQuotes": false or true
  • true if '' are allowed for strings (both keys and values)
• "stackLimit": integer
  • Exceeding stackLimit (recursive depth of readValue()) will cause an exception.
  • This is a security issue (seg-faults caused by deeply nested JSON), so the default is low.
• "failIfExtra": false or true
  • If true, parse() returns false when extra non-whitespace trails the JSON value in the input string.
• "rejectDupKeys": false or true
  • If true, parse() returns false when a key is duplicated within an object.
• "allowSpecialFloats": false or true
  • If true, special float values (NaNs and infinities) are allowed and their values are lossfree restorable.

You can examine 'settings_` yourself to see the defaults. You can also write and read them just like any JSON Value.

See also

setDefaults()

---

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

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