bes Updated for version 3.20.13
ParseResult Struct Reference

Result of parsing (wraps ParseErrorCode) More...

#include <error.h>

Collaboration diagram for ParseResult:
Collaboration graph

Public Types

typedef bool(ParseResult::* BooleanType) () const
 ! Unspecified boolean type
 

Public Member Functions

void Clear ()
 Reset error code.
 
ParseErrorCode Code () const
 Get the error code.
 
bool IsError () const
 Whether the result is an error.
 
size_t Offset () const
 Get the error offset, if IsError(), 0 otherwise.
 
 operator BooleanType () const
 Explicit conversion to bool, returns true, iff !IsError().
 
bool operator!= (const ParseResult &that) const
 
bool operator!= (ParseErrorCode code) const
 
bool operator== (const ParseResult &that) const
 
bool operator== (ParseErrorCode code) const
 
 ParseResult ()
 Default constructor, no error.
 
 ParseResult (ParseErrorCode code, size_t offset)
 Constructor to set an error.
 
void Set (ParseErrorCode code, size_t offset=0)
 Update error code and offset.
 

Friends

bool operator!= (ParseErrorCode code, const ParseResult &err)
 
bool operator== (ParseErrorCode code, const ParseResult &err)
 

Detailed Description

Result of parsing (wraps ParseErrorCode)

ParseResult ok = doc.Parse("[42]");
if (!ok) {
fprintf(stderr, "JSON parse error: %s (%u)",
exit(EXIT_FAILURE);
}
A document for parsing JSON text as DOM.
Definition: document.h:2203
GenericDocument & Parse(const typename SourceEncoding::Ch *str)
Parse JSON text from a read-only string (with Encoding conversion)
Definition: document.h:2404
RAPIDJSON_NAMESPACE_BEGIN const RAPIDJSON_ERROR_CHARTYPE * GetParseError_En(ParseErrorCode parseErrorCode)
Maps error code of parsing into error message.
Definition: en.h:36
Result of parsing (wraps ParseErrorCode)
Definition: error.h:106
ParseErrorCode Code() const
Get the error code.
Definition: error.h:116
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
Definition: error.h:118
See also
GenericReader::Parse, GenericDocument::Parse

Definition at line 106 of file error.h.

Member Typedef Documentation

◆ BooleanType

typedef bool(ParseResult::* ParseResult::BooleanType) () const

! Unspecified boolean type

Definition at line 108 of file error.h.

Constructor & Destructor Documentation

◆ ParseResult() [1/2]

ParseResult::ParseResult ( )
inline

Default constructor, no error.

Definition at line 111 of file error.h.

◆ ParseResult() [2/2]

ParseResult::ParseResult ( ParseErrorCode  code,
size_t  offset 
)
inline

Constructor to set an error.

Definition at line 113 of file error.h.

Member Function Documentation

◆ Clear()

void ParseResult::Clear ( )
inline

Reset error code.

Definition at line 134 of file error.h.

◆ Code()

ParseErrorCode ParseResult::Code ( ) const
inline

Get the error code.

Definition at line 116 of file error.h.

◆ IsError()

bool ParseResult::IsError ( ) const
inline

Whether the result is an error.

Definition at line 123 of file error.h.

◆ Offset()

size_t ParseResult::Offset ( ) const
inline

Get the error offset, if IsError(), 0 otherwise.

Definition at line 118 of file error.h.

◆ operator BooleanType()

ParseResult::operator BooleanType ( ) const
inline

Explicit conversion to bool, returns true, iff !IsError().

Definition at line 121 of file error.h.

◆ operator!=() [1/2]

bool ParseResult::operator!= ( const ParseResult that) const
inline

Definition at line 129 of file error.h.

◆ operator!=() [2/2]

bool ParseResult::operator!= ( ParseErrorCode  code) const
inline

Definition at line 130 of file error.h.

◆ operator==() [1/2]

bool ParseResult::operator== ( const ParseResult that) const
inline

Definition at line 125 of file error.h.

◆ operator==() [2/2]

bool ParseResult::operator== ( ParseErrorCode  code) const
inline

Definition at line 126 of file error.h.

◆ Set()

void ParseResult::Set ( ParseErrorCode  code,
size_t  offset = 0 
)
inline

Update error code and offset.

Definition at line 136 of file error.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( ParseErrorCode  code,
const ParseResult err 
)
friend

Definition at line 131 of file error.h.

◆ operator==

bool operator== ( ParseErrorCode  code,
const ParseResult err 
)
friend

Definition at line 127 of file error.h.


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