ParseResult

Result of parsing (wraps ParseErrorCode) More...

#include <error.h>

Collaboration diagram for ParseResult:

Public Types
typedef bool(ParseResult::*	BooleanType) () const
	! Unspecified boolean type More...

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

Private Attributes
ParseErrorCode	code_
size_t	offset_

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

Detailed Description

Result of parsing (wraps ParseErrorCode)

Document doc;
ParseResult ok = doc.Parse("[42]");
if (!ok) {
    fprintf(stderr, "JSON parse error: %s (%u)",
            GetParseError_En(ok.Code()), ok.Offset());
    exit(EXIT_FAILURE);
}

See also

GenericReader::Parse, GenericDocument::Parse

Definition at line 106 of file error.h.

Member Typedef Documentation

BooleanType

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

! Unspecified boolean type

Definition at line 108 of file error.h.

Constructor & Destructor Documentation

ParseResult() [1/2]

ParseResult ( )

inline

Default constructor, no error.

Definition at line 111 of file error.h.

: code_(kParseErrorNone), offset_(0) {}

ParseResult() [2/2]

ParseResult ( ParseErrorCode  code, size_t  offset  )

inline

Constructor to set an error.

Definition at line 113 of file error.h.

: code_(code), offset_(offset) {}

Member Function Documentation

Clear()

void Clear ( )

inline

Reset error code.

Definition at line 134 of file error.h.

{ Set(kParseErrorNone); }

Here is the call graph for this function:

Here is the caller graph for this function:

Code()

ParseErrorCode Code ( ) const

inline

Get the error code.

Definition at line 116 of file error.h.

{ return code_; }

IsError()

bool IsError ( ) const

inline

Whether the result is an error.

Definition at line 123 of file error.h.

{ return code_ != kParseErrorNone; }

Here is the caller graph for this function:

Offset()

size_t Offset ( ) const

inline

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

Definition at line 118 of file error.h.

{ return offset_; }

operator BooleanType()

operator BooleanType ( ) const

inline

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

Definition at line 121 of file error.h.

{ return !IsError() ? &ParseResult::IsError : NULL; }

Here is the call graph for this function:

operator!=() [1/2]

bool operator!= ( const ParseResult &  that ) const

inline

Definition at line 129 of file error.h.

{ return !(*this == that); }

operator!=() [2/2]

bool operator!= ( ParseErrorCode  code ) const

inline

Definition at line 130 of file error.h.

{ return !(*this == code); }

operator==() [1/2]

bool operator== ( const ParseResult &  that ) const

inline

Definition at line 125 of file error.h.

{ return code_ == that.code_; }

operator==() [2/2]

bool operator== ( ParseErrorCode  code ) const

inline

Definition at line 126 of file error.h.

{ return code_ == code; }

Set()

void Set ( ParseErrorCode  code, size_t  offset = 0  )

inline

Update error code and offset.

Definition at line 136 of file error.h.

{ code_ = code; offset_ = offset; }

Here is the caller graph for this function:

Friends And Related Function Documentation

operator!=

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

friend

Definition at line 131 of file error.h.

{ return err != code; }

operator==

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

friend

Definition at line 127 of file error.h.

{ return code == err.code_; }

Member Data Documentation

code_

ParseErrorCode code_

private

Definition at line 139 of file error.h.

offset_

size_t offset_

private

Definition at line 140 of file error.h.

---

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

• rapidjson/error/error.h