Namespace rapidjson

Description

main RapidJSON namespace

See
RAPIDJSON_NAMESPACE

RapidJSON error handling

ParseResultResult of parsing (wraps ParseErrorCode)
GetParseError_EnMaps error code of parsing into error message.
GetValidateError_EnMaps error code of validation into error message.
ParseErrorCodeError code of parsing.
ValidateErrorCodeError codes when validating.
PointerParseErrorCodeError code of parsing.

typedef const RAPIDJSON_ERROR_CHARTYPE *(* GetParseErrorFunc)(ParseErrorCode)

Function pointer type of GetParseError().

This is the prototype for GetParseError_X(), where X is a locale. User can dynamically change locale in runtime, e.g.:

GetParseErrorFunc GetParseError = GetParseError_En; // or whatever
const RAPIDJSON_ERROR_CHARTYPE* s = GetParseError(document.GetParseErrorCode());

typedef const RAPIDJSON_ERROR_CHARTYPE *(* GetValidateErrorFunc)(ValidateErrorCode)

Function pointer type of GetValidateError().

This is the prototype for GetValidateError_X(), where X is a locale. User can dynamically change locale in runtime, e.g.:

GetValidateErrorFunc GetValidateError = GetValidateError_En; // or whatever
const RAPIDJSON_ERROR_CHARTYPE* s = GetValidateError(validator.GetInvalidSchemaCode());

Helper functions for GenericPointer

CreateValueByPointer overload

Mentioned in

EraseValueByPointer overload

Mentioned in

GetValueByPointer overload

Mentioned in

GetValueByPointerWithDefault overload

Mentioned in

SetValueByPointer overload

Mentioned in

SwapValueByPointer overload

Mentioned in

Namespaces

internal

Classes

AllocatorConcept for allocating, resizing and freeing memory block.
ASCIIASCII encoding.
AutoUTFDynamically select encoding according to stream's runtime-specified UTF encoding type.
AutoUTFInputStreamInput stream wrapper with dynamically bound encoding and automatic encoding detection.
AutoUTFOutputStreamOutput stream wrapper with dynamically bound encoding and automatic encoding detection.
BaseReaderHandlerDefault implementation of Handler.
BasicIStreamWrapperWrapper of std::basic_istream into RapidJSON's Stream concept.
BasicOStreamWrapperWrapper of std::basic_ostream into RapidJSON's Stream concept.
CrtAllocatorC-runtime library allocator.
CursorStreamWrapperCursor stream wrapper for counting line and column number if error exists.
EncodedInputStreamInput byte stream wrapper with a statically bound encoding.
EncodedInputStream< UTF8<>, MemoryStream >Specialized for UTF8 MemoryStream.
EncodedOutputStreamOutput byte stream wrapper with statically bound encoding.
EncodingConcept for encoding of Unicode characters.
FileReadStreamFile byte stream for input using fread().
FileWriteStreamWrapper of C file stream for output using fwrite().
GenericArrayHelper class for accessing Value of array type.
GenericDocumentA document for parsing JSON text as DOM.
GenericInsituStringStreamA read-write string stream.
GenericMemberName-value pair in a JSON object value.
GenericMemberIterator(Constant) member iterator for a JSON object value
GenericMemoryBufferRepresents an in-memory output byte stream.
GenericObjectHelper class for accessing Value of object type.
GenericPointerRepresents a JSON Pointer. Use Pointer for UTF8 encoding and default allocator.
GenericReaderSAX-style JSON parser. Use Reader for UTF8 encoding and default allocator.
GenericSchemaDocumentJSON schema document.
GenericSchemaValidatorJSON Schema Validator.
GenericStreamWrapperA Stream Wrapper.
GenericStringBufferRepresents an in-memory output stream.
GenericStringRefReference to a constant string (not taking a copy)
GenericStringStreamRead-only string stream.
GenericValueRepresents a JSON value. Use Value for UTF8 encoding and default allocator.
HandlerConcept for receiving events from GenericReader upon parsing. The functions return true if no error occurs. If they return false, the event publisher should terminate the process.
IGenericRemoteSchemaDocumentProvider
MemoryPoolAllocatorDefault memory allocator used by the parser and DOM.
MemoryStreamRepresents an in-memory input byte stream.
PrettyWriterWriter with indentation and spacing.
SchemaValidatingReaderA helper class for parsing with validation.
StdAllocator
StdAllocator< void, BaseAllocator >
StreamConcept for reading and writing characters.
StreamTraitsProvides additional information for stream.
StreamTraits< GenericInsituStringStream< Encoding > >
StreamTraits< GenericStringStream< Encoding > >
TranscoderEncoding conversion.
Transcoder< Encoding, Encoding >Specialization of Transcoder with same source and target encoding.
UTF16UTF-16 encoding.
UTF16BEUTF-16 big endian encoding.
UTF16LEUTF-16 little endian encoding.
UTF32UTF-32 encoding.
UTF32BEUTF-32 big endian encoding.
UTF32LEUTF-32 little endian enocoding.
UTF8UTF-8 encoding.
WriterJSON writer.

Functions

Free
Malloc
PutN overloadImplement specialized version of PutN() with memset() for better performance.
PutN overloadPut N copies of a character to a stream.
PutReserve overloadReserve n characters for writing to a stream.
PutUnsafe overloadWrite character to a stream, presuming buffer is reserved.
Realloc
SkipWhitespace overloadSkip the JSON white spaces in a stream.
SkipWhitespace overloadTemplate function specialization for InsituStringStream.
SkipWhitespace overloadTemplate function specialization for StringStream.
StringRef overloadMark a character pointer as constant string.
StringRef overloadMark a string object as constant string.

Enums

UTFTypeRuntime-specified UTF encoding type of a stream.
PrettyFormatOptionsCombination of PrettyWriter format flags.
TypeType of JSON value.
ParseFlagCombination of parseFlags.
ValidateFlagCombination of validate flags.
WriteFlagCombination of writeFlags.

Typedefs

Typedefs (document.h)

typedef GenericValue< UTF8<> > Value

GenericValue with UTF8 encoding.

typedef GenericDocument< UTF8<> > Document

GenericDocument with UTF8 encoding.

Mentioned in:

Getting Started / Usage at a glance

Changelog / Added

Changelog / Fixed

Changelog / Changed

Changelog / Removed

Features / API styles

Features / DOM (Document)

Tutorial / Tutorial

Tutorial / Value & Document {#ValueDocument}

Tutorial / Query Value {#QueryValue}

Tutorial / Query String {#QueryString}

Tutorial / Change Value Type {#ChangeValueType}

Tutorial / Move Semantics {#MoveSemantics}

Tutorial / Move semantics and temporary values {#TemporaryValues}

Tutorial / Create String {#CreateString}

Tutorial / Modify Array {#ModifyArray}

Tutorial / Deep Copy Value {#DeepCopyValue}

Pointer / Pointer

Pointer / Basic Usage {#BasicUsage}

Pointer / Helper Functions {#HelperFunctions}

Pointer / Resolving Minus Sign Token

Pointer / Resolving Document and Value

Stream / StringStream (Input) {#StringStream}

Stream / FileReadStream (Input) {#FileReadStream}

Stream / FileWriteStream (Output) {#FileWriteStream}

Stream / IStreamWrapper {#IStreamWrapper}

Stream / OStreamWrapper {#OStreamWrapper}

Stream / EncodedInputStream {#EncodedInputStream}

Stream / EncodedOutputStream {#EncodedOutputStream}

Stream / AutoUTFInputStream {#AutoUTFInputStream}

Stream / AutoUTFOutputStream {#AutoUTFOutputStream}

Stream / Example: istream wrapper {#ExampleIStreamWrapper}

Stream / Example: ostream wrapper {#ExampleOStreamWrapper}

Encoding / ASCII {#ASCII}

Dom / DOM

Dom / Template {#Template}

Dom / Allocator {#Allocator}

Dom / Parsing {#Parsing}

Dom / Parse Error {#ParseError}

Dom / In Situ Parsing {#InSituParsing}

Sax / Parsing {#SaxParsing}

Sax / Writer {#Writer}

Sax / Parsing JSON to Custom Data Structure {#CustomDataStructure}

Schema / Basic Usage {#Basic}

Schema / DOM parsing {#DOM}

Internals / SAX and DOM

Faq / DOM and SAX

Examples / tutorial.cpp

Examples / schemavalidator.cpp

Examples / parsebyparts.cpp

Examples / filterkeydom.cpp

Examples / sortkeys.cpp

Examples / simpledom.cpp

Typedefs (istreamwrapper.h)

typedef BasicIStreamWrapper< std::istream > IStreamWrapper

Mentioned in:

typedef BasicIStreamWrapper< std::wistream > WIStreamWrapper

Mentioned in:

Typedefs (memorybuffer.h)

typedef GenericMemoryBuffer MemoryBuffer

Typedefs (ostreamwrapper.h)

typedef BasicOStreamWrapper< std::ostream > OStreamWrapper

Mentioned in:

typedef BasicOStreamWrapper< std::wostream > WOStreamWrapper

Mentioned in:

Typedefs (pointer.h)

typedef GenericPointer< Value > Pointer

GenericPointer for Value (UTF-8, default allocator).

Mentioned in:

Changelog / Added

Features / Standard compliance

Pointer / Pointer

Pointer / JSON Pointer {#JsonPointer}

Pointer / Basic Usage {#BasicUsage}

Pointer / Helper Functions {#HelperFunctions}

Pointer / Resolving Pointer {#ResolvingPointer}

Pointer / Error Handling {#ErrorHandling}

Pointer / URI Fragment Representation {#URIFragment}

Pointer / Stringify

Pointer / User-Supplied Tokens {#UserSuppliedTokens}

Schema / General provisions {#ReportingGeneral}

Internals / Data Layout {#DataLayout}

Typedefs (rapidjson.h)

typedef unsigned SizeType

Size type (for string lengths, array sizes, etc.)

RapidJSON uses 32-bit array/string indices even on 64-bit platforms, instead of using size_t. Users may override the SizeType by defining RAPIDJSON_NO_SIZETYPEDEFINE.

Mentioned in:

Tutorial / Query Value {#QueryValue}

Tutorial / Query Array {#QueryArray}

Tutorial / Modify Array {#ModifyArray}

Sax / Reader {#Reader}

Sax / Handler {#Handler}

Sax / GenericReader {#GenericReader}

Sax / Writer {#Writer}

Sax / Parsing JSON to Custom Data Structure {#CustomDataStructure}

Sax / Filtering of JSON {#Filtering}

Schema / Remote Schema {#Remote}

Internals / Data Layout {#DataLayout}

Examples / tutorial.cpp

Examples / simplereader.cpp

Examples / capitalize.cpp

Examples / messagereader.cpp

Examples / serialize.cpp

Examples / jsonx.cpp

Examples / filterkey.cpp

Examples / filterkeydom.cpp

Typedefs (reader.h)

typedef GenericReader< UTF8<>, UTF8<> > Reader

Reader with UTF8 encoding and default allocator.

Mentioned in:

Getting Started / Usage at a glance

Changelog / Changed

Tutorial / What's next {#WhatsNext}

Encoding / ASCII {#ASCII}

Encoding / Validation & Transcoding {#ValidationTranscoding}

Sax / SAX

Sax / Reader {#Reader}

Sax / Handler {#Handler}

Sax / GenericReader {#GenericReader}

Sax / Parsing {#SaxParsing}

Sax / Writer {#Writer}

Sax / Template {#WriterTemplate}

Sax / Parsing JSON to Custom Data Structure {#CustomDataStructure}

Sax / Filtering of JSON {#Filtering}

Schema / SAX parsing {#SAX}

Internals / SAX and DOM

Faq / Performance

Examples / simplereader.cpp

Examples / condense.cpp

Examples / pretty.cpp

Examples / capitalize.cpp

Examples / messagereader.cpp

Examples / jsonx.cpp

Examples / schemavalidator.cpp

Examples / prettyauto.cpp

Examples / filterkey.cpp

Examples / filterkeydom.cpp

Typedefs (schema.h)

typedef GenericSchemaDocument< Value > SchemaDocument

GenericSchemaDocument using Value type.

Mentioned in:

Schema / Basic Usage {#Basic}

Schema / DOM parsing {#DOM}

Schema / SAX parsing {#SAX}

Schema / Serialization {#Serialization}

Schema / Remote Schema {#Remote}

Schema / pattern {#pattern}

Schema / enum {#enum}

Examples / schemavalidator.cpp

typedef IGenericRemoteSchemaDocumentProvider< SchemaDocument > IRemoteSchemaDocumentProvider

IGenericRemoteSchemaDocumentProvider using SchemaDocument.

Mentioned in:

Schema / Remote Schema {#Remote}

Schema / General provisions {#ReportingGeneral}

typedef GenericSchemaValidator< SchemaDocument > SchemaValidator

Mentioned in:

Typedefs (stream.h)

typedef GenericStringStream< UTF8<> > StringStream

String stream with UTF8 encoding.

Mentioned in:

Stream / StringStream (Input) {#StringStream}

Stream / File Streams {#FileStreams}

Encoding / Transcoder {#Transcoder}

Sax / Reader {#Reader}

Sax / Parsing JSON to Custom Data Structure {#CustomDataStructure}

Examples / simplereader.cpp

Examples / messagereader.cpp

typedef GenericInsituStringStream< UTF8<> > InsituStringStream

Insitu string stream with UTF8 encoding.

Typedefs (stringbuffer.h)

typedef GenericStringBuffer< UTF8<> > StringBuffer

String buffer with UTF8 encoding.

Mentioned in:

Getting Started / Usage at a glance

Pointer / Stringify

Stream / StringBuffer (Output) {#StringBuffer}

Encoding / ASCII {#ASCII}

Dom / DOM as SAX Event Publisher

Sax / Writer {#Writer}

Schema / Basic Usage {#Basic}

Schema / DOM parsing {#DOM}

Schema / Serialization {#Serialization}

Examples / tutorial.cpp

Examples / serialize.cpp

Examples / jsonx.cpp

Examples / schemavalidator.cpp

Examples / simplewriter.cpp

Examples / simpledom.cpp

Variables

Variables (pointer.h)

const SizeType kPointerInvalidIndex = ~SizeType(0)

Represents an invalid index in GenericPointer::Token.

Mentioned in:

Pointer / User-Supplied Tokens {#UserSuppliedTokens}

Source

Line 27 in include/rapidjson/allocators.h.






Add Discussion as Guest

Log in