rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, Allocator > Class Template Reference

JSON writer. More...

#include <writer.h>

Inheritance diagram for rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, Allocator >:

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

Public Types
typedef SourceEncoding::Ch	Ch

Public Member Functions
	Writer (OutputStream &os, Allocator *allocator=0, size_t levelDepth=kDefaultLevelDepth)
	Constructor. More...
	Writer (Allocator *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	EndObject (SizeType memberCount=0)
bool	StartArray ()
bool	EndArray (SizeType elementCount=0)
Convenience extensions
bool	String (const Ch *str)
	Simpler but slower overload.

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< Allocator >	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 Allocator = MemoryPoolAllocator<>>
class rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, Allocator >

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.
Allocator	Type of allocator for allocating memory of stack.

Note

implements Handler concept

Constructor & Destructor Documentation

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename Allocator = MemoryPoolAllocator<>>

rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, Allocator >::Writer ( OutputStream &  os, Allocator *  allocator = 0, size_t  levelDepth = kDefaultLevelDepth  )

inline

Constructor.

Parameters

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

Member Function Documentation

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename Allocator = MemoryPoolAllocator<>>

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

inline

Writes the given double value to the stream.

Parameters

d	The value to be written.

Returns

Whether it is succeed.

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename Allocator = MemoryPoolAllocator<>>

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

inline

Checks whether the output is a complete JSON.

A complete JSON has a complete root object or array.

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename Allocator = MemoryPoolAllocator<>>

void rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, Allocator >::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();

---

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

• include/rapidjson/writer.h