Torque2D Reference
Classes | Public Types | Public Member Functions | List of all members
GenericReader< SourceEncoding, TargetEncoding, Allocator > Class Template Reference

SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator. More...

#include <reader.h>

Public Types

typedef SourceEncoding::Ch Ch
 

Public Member Functions

 GenericReader (Allocator *allocator=0, size_t stackCapacity=kDefaultStackCapacity)
 Constructor. More...
 
template<unsigned parseFlags, typename InputStream , typename Handler >
bool Parse (InputStream &is, Handler &handler)
 Parse JSON text. More...
 
bool HasParseError () const
 
const char * GetParseError () const
 
size_t GetErrorOffset () const
 

Detailed Description

template<typename SourceEncoding, typename TargetEncoding, typename Allocator = MemoryPoolAllocator<>>
class rapidjson::GenericReader< SourceEncoding, TargetEncoding, Allocator >

SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator.

GenericReader parses JSON text from a stream, and send events synchronously to an object implementing Handler concept.

It needs to allocate a stack for storing a single decoded string during non-destructive parsing.

For in-situ parsing, the decoded string is directly written to the source text string, no temporary buffer is required.

A GenericReader object can be reused for parsing multiple JSON text.

Template Parameters
SourceEncodingEncoding of the input stream.
TargetEncodingEncoding of the parse output.
AllocatorAllocator type for stack.

Member Typedef Documentation

typedef SourceEncoding::Ch Ch

Constructor & Destructor Documentation

GenericReader ( Allocator allocator = 0,
size_t  stackCapacity = kDefaultStackCapacity 
)
inline

Constructor.

Parameters
allocatorOptional allocator for allocating stack memory. (Only use for non-destructive parsing)
stackCapacitystack capacity in bytes for storing a single decoded string. (Only use for non-destructive parsing)

Member Function Documentation

size_t GetErrorOffset ( ) const
inline
const char* GetParseError ( ) const
inline
bool HasParseError ( ) const
inline
bool Parse ( InputStream &  is,
Handler handler 
)
inline

Parse JSON text.

Template Parameters
parseFlagsCombination of ParseFlag.
InputStreamType of input stream.
HandlerType of handler which must implement Handler concept.
Parameters
streamInput stream to be parsed.
handlerThe handler to receive events.
Returns
Whether the parsing is successful.

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