Json Namespace Reference

JSON (JavaScript Object Notation). More...

Classes
class	Reader
	Unserialize a JSON document into a Value. More...
class	StaticString
	Lightweight wrapper to tag static string. More...
class	Value
	Represents a JSON value. More...
class	PathArgument
	Experimental and untested: represents an element of the "path" to access a node. More...
class	Path
	Experimental and untested: represents a "path" to access a node. More...
class	ValueAllocator
	Allocator to customize member name and string value memory management done by Value. More...
class	ValueIteratorBase
	Experimental and untested: base class for Value iterators. More...
class	ValueConstIterator
	Experimental and untested: const iterator for object and array value. More...
class	ValueIterator
	Experimental and untested: iterator for object and array value. More...
class	Writer
	Abstract class for writers. More...
class	FastWriter
	Outputs a Value in JSON format without formatting (not human friendly). More...
class	StyledWriter
	Writes a Value in JSON format in a human friendly way. More...
class	StyledStreamWriter
	Writes a Value in JSON format in a human friendly way, to a stream rather than to a string. More...
class	BatchAllocator
class	DefaultValueAllocator
struct	DummyValueAllocatorInitializer
Enumerations
enum	ValueType {   nullValue = 0, intValue, uintValue, realValue,   stringValue, booleanValue, arrayValue, objectValue }
	Type of the value held by a Value object. More...
enum	CommentPlacement { commentBefore = 0, commentAfterOnSameLine, commentAfter, numberOfCommentPlacement }
Functions
std::istream &	operator>> (std::istream &, Value &)
	Read from 'sin' into 'root'.
std::string JSON_API	valueToString (Value::Int value)
std::string JSON_API	valueToString (Value::UInt value)
std::string JSON_API	valueToString (double value)
std::string JSON_API	valueToString (bool value)
std::string JSON_API	valueToQuotedString (const char *value)
std::ostream &	operator<< (std::ostream &, const Value &root)
	Output using the StyledStreamWriter.

---

Detailed Description

JSON (JavaScript Object Notation).

---

Enumeration Type Documentation

enum Json::CommentPlacement

Enumerator:

commentBefore	a comment placed on the line before a value
commentAfterOnSameLine	a comment just after a value on the same line
commentAfter	a comment on the line after a value (only make sense for root value)

enum Json::ValueType

Type of the value held by a Value object.

Enumerator:

nullValue	'null' value
intValue	signed integer value
uintValue	unsigned integer value
realValue	double value
stringValue	UTF-8 string value.
booleanValue	bool value
arrayValue	array value (ordered list)
objectValue	object value (collection of name/value pairs).

---

Function Documentation

std::ostream & Json::operator<<	(	std::ostream &	sout,
		const Value &	root
	)

Output using the StyledStreamWriter.

See also:

Json::operator>>()

std::istream & Json::operator>>	(	std::istream &	sin,
		Value &	root
	)

Read from 'sin' into 'root'.

Always keep comments from the input JSON.

This can be used to read a file into a particular sub-object. For example:

    Json::Value root;
    cin >> root["dir"]["file"];
    cout << root;

Result:

    {
	"dir": {
	    "file": {
		// The input stream JSON would be nested here.
	    }
	}
    }
    

Exceptions:

std::exception

on parse error.

See also:

Json::operator<<()