ParseResult Struct Reference

Result of parsing (wraps ParseErrorCode) More...

#include <error.h>

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 bool () const
	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
void	Clear ()
	Reset error code. More...
void	Set (ParseErrorCode code, size_t offset=0)
	Update error code and offset. More...

Friends
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.

Constructor & Destructor Documentation

ParseResult() [1/2]

ParseResult::ParseResult ( )

inline

Default constructor, no error.

Definition at line 109 of file error.h.

ParseResult() [2/2]

ParseResult::ParseResult ( ParseErrorCode  code, size_t  offset  )

inline

Constructor to set an error.

Definition at line 111 of file error.h.

Member Function Documentation

Clear()

void ParseResult::Clear ( )

inline

Reset error code.

Definition at line 128 of file error.h.

Code()

ParseErrorCode ParseResult::Code ( ) const

inline

Get the error code.

Definition at line 114 of file error.h.

IsError()

bool ParseResult::IsError ( ) const

inline

Whether the result is an error.

Definition at line 121 of file error.h.

Offset()

size_t ParseResult::Offset ( ) const

inline

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

Definition at line 116 of file error.h.

operator bool()

ParseResult::operator bool ( ) const

inline

Conversion to bool, returns true, iff !IsError().

Definition at line 119 of file error.h.

operator==() [1/2]

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

inline

Definition at line 123 of file error.h.

operator==() [2/2]

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

inline

Definition at line 124 of file error.h.

Set()

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

inline

Update error code and offset.

Definition at line 130 of file error.h.

Friends And Related Function Documentation

operator==

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

friend

Definition at line 125 of file error.h.

---

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

• /home/runner/work/cphot/cphot/include/rapidjson/error/error.h