JSON writer. More...

#include <writer.h>

Inheritance diagram for Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >:

Classes
struct	Level
	Information for each nested level. More...

Public Types
typedef SourceEncoding::Ch	Ch

Public Member Functions
	Writer (OutputStream &os, StackAllocator *stackAllocator=0, size_t levelDepth=kDefaultLevelDepth)
	Constructor. More...

	Writer (StackAllocator *allocator=0, size_t levelDepth=kDefaultLevelDepth)

void	Reset (OutputStream &os)
	Reset the writer with a new stream. More...

bool	IsComplete () const
	Checks whether the output is a complete JSON. More...

Implementation of Handler
See also Handler
bool	Null ()

bool	Bool (bool b)

bool	Int (int i)

bool	Uint (unsigned u)

bool	Int64 (int64_t i64)

bool	Uint64 (uint64_t u64)

bool	Double (double d)
	Writes the given `double` value to the stream. More...

bool	String (const Ch *str, SizeType length, bool copy=false)

bool	StartObject ()

bool	Key (const Ch *str, SizeType length, bool copy=false)

bool	EndObject (SizeType memberCount=0)

bool	StartArray ()

bool	EndArray (SizeType elementCount=0)

Convenience extensions
bool	String (const Ch *str)
	Simpler but slower overload. More...

bool	Key (const Ch *str)

Protected Member Functions
bool	WriteNull ()

bool	WriteBool (bool b)

bool	WriteInt (int i)

bool	WriteUint (unsigned u)

bool	WriteInt64 (int64_t i64)

bool	WriteUint64 (uint64_t u64)

bool	WriteDouble (double d)

bool	WriteString (const Ch *str, SizeType length)

bool	WriteStartObject ()

bool	WriteEndObject ()

bool	WriteStartArray ()

bool	WriteEndArray ()

void	Prefix (Type type)

template<>
bool	WriteInt (int i)

template<>
bool	WriteUint (unsigned u)

template<>
bool	WriteInt64 (int64_t i64)

template<>
bool	WriteUint64 (uint64_t u)

template<>
bool	WriteDouble (double d)

Protected Attributes
OutputStream *	os_

internal::Stack< StackAllocator >	level_stack_

bool	hasRoot_

Static Protected Attributes
static const size_t	kDefaultLevelDepth = 32

Detailed Description

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>
class Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >

JSON writer.

Writer implements the concept Handler. It generates JSON text by events to an output os.

User may programmatically calls the functions of a writer to generate JSON text.

On the other side, a writer can also be passed to objects that generates events,

for example Reader::Parse() and Document::Accept().

Template Parameters

OutputStream	Type of output stream.
SourceEncoding	Encoding of source string.
TargetEncoding	Encoding of output stream.
StackAllocator	Type of allocator for allocating memory of stack.

Note: implements Handler concept

Member Typedef Documentation

◆ Ch

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

typedef SourceEncoding::Ch Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Ch

Constructor & Destructor Documentation

◆ Writer() [1/2]

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Writer	(	OutputStream &	os,
		StackAllocator *	stackAllocator = `0`,
		size_t	levelDepth = `kDefaultLevelDepth`
	)

inlineexplicit

Constructor.

Parameters

os	Output stream.
stackAllocator	User supplied allocator. If it is null, it will create a private one.
levelDepth	Initial capacity of stack.

◆ Writer() [2/2]

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Writer	(	StackAllocator *	allocator = `0`,
		size_t	levelDepth = `kDefaultLevelDepth`
	)

inlineexplicit

Member Function Documentation

◆ Bool()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Bool ( bool b )

inline

◆ Double()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Double ( double d )

inline

Writes the given double value to the stream.

Parameters

d	The value to be written.

Returns: Whether it is succeed.

◆ EndArray()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::EndArray ( SizeType elementCount = 0 )

inline

◆ EndObject()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::EndObject ( SizeType memberCount = 0 )

inline

◆ Int()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Int ( int i )

inline

◆ Int64()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Int64 ( int64_t i64 )

inline

◆ IsComplete()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::IsComplete ( ) const

inline

Checks whether the output is a complete JSON.

A complete JSON has a complete root object or array.

◆ Key() [1/2]

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Key	(	const Ch *	str,
		SizeType	length,
		bool	copy = `false`
	)

inline

◆ Key() [2/2]

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Key ( const Ch * str )

inline

◆ Null()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Null ( )

inline

◆ Prefix()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

void Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Prefix ( Type type )

inlineprotected

◆ Reset()

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

void Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Reset ( OutputStream & os )

inline

Reset the writer with a new stream.

This function reset the writer with a new stream and default settings, in order to make a Writer object reusable for output multiple JSONs.

Parameters

os	New output stream. Writer<OutputStream> writer(os1); writer.StartObject(); // ... writer.EndObject(); writer.Reset(os2); writer.StartObject(); // ... writer.EndObject();

◆ StartArray()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::StartArray ( )

inline

◆ StartObject()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::StartObject ( )

inline

◆ String() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::String	(	const Ch *	str,
		SizeType	length,
		bool	copy = `false`
	)

inline

◆ String() [2/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::String ( const Ch * str )

inline

Simpler but slower overload.

◆ Uint()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Uint ( unsigned u )

inline

◆ Uint64()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Uint64 ( uint64_t u64 )

inline

◆ WriteBool()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteBool ( bool b )

inlineprotected

◆ WriteDouble() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteDouble ( double d )

inlineprotected

◆ WriteDouble() [2/2]

template<>

bool Writer< StringBuffer >::WriteDouble ( double d )

inlineprotected

◆ WriteEndArray()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteEndArray ( )

inlineprotected

◆ WriteEndObject()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteEndObject ( )

inlineprotected

◆ WriteInt() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteInt ( int i )

inlineprotected

◆ WriteInt() [2/2]

template<>

bool Writer< StringBuffer >::WriteInt ( int i )

inlineprotected

◆ WriteInt64() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteInt64 ( int64_t i64 )

inlineprotected

◆ WriteInt64() [2/2]

template<>

bool Writer< StringBuffer >::WriteInt64 ( int64_t i64 )

inlineprotected

◆ WriteNull()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteNull ( )

inlineprotected

◆ WriteStartArray()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteStartArray ( )

inlineprotected

◆ WriteStartObject()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteStartObject ( )

inlineprotected

◆ WriteString()

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteString	(	const Ch *	str,
		SizeType	length
	)

inlineprotected

◆ WriteUint() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteUint ( unsigned u )

inlineprotected

◆ WriteUint() [2/2]

template<>

bool Writer< StringBuffer >::WriteUint ( unsigned u )

inlineprotected

◆ WriteUint64() [1/2]

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteUint64 ( uint64_t u64 )

inlineprotected

◆ WriteUint64() [2/2]

template<>

bool Writer< StringBuffer >::WriteUint64 ( uint64_t u )

inlineprotected

Member Data Documentation

◆ hasRoot_

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::hasRoot_

protected

◆ kDefaultLevelDepth

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

const size_t Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::kDefaultLevelDepth = 32

staticprotected

◆ level_stack_

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

internal::Stack<StackAllocator> Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::level_stack_

protected

◆ os_

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

OutputStream* Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::os_

protected

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

Source/ThirdParty/ANGLE/src/tests/third_party/rapidjson/include/rapidjson/writer.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator> class Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >

Member Typedef Documentation

◆ Ch

Constructor & Destructor Documentation

◆ Writer() [1/2]

◆ Writer() [2/2]

Member Function Documentation

◆ Bool()

◆ Double()

◆ EndArray()

◆ EndObject()

◆ Int()

◆ Int64()

◆ IsComplete()

◆ Key() [1/2]

◆ Key() [2/2]

◆ Null()

◆ Prefix()

◆ Reset()

◆ StartArray()

◆ StartObject()

◆ String() [1/2]

◆ String() [2/2]

◆ Uint()

◆ Uint64()

◆ WriteBool()

◆ WriteDouble() [1/2]

◆ WriteDouble() [2/2]

◆ WriteEndArray()

◆ WriteEndObject()

◆ WriteInt() [1/2]

◆ WriteInt() [2/2]

◆ WriteInt64() [1/2]

◆ WriteInt64() [2/2]

◆ WriteNull()

◆ WriteStartArray()

◆ WriteStartObject()

◆ WriteString()

◆ WriteUint() [1/2]

◆ WriteUint() [2/2]

◆ WriteUint64() [1/2]

◆ WriteUint64() [2/2]

Member Data Documentation

◆ hasRoot_

◆ kDefaultLevelDepth

◆ level_stack_

◆ os_

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>
class Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >