NGL  6.5
The NCCA Graphics Library
ParseResult Struct Reference

Result of parsing (wraps ParseErrorCode) More...

#include <error.h>

+ Collaboration diagram for ParseResult:

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

Private Attributes

ParseErrorCode code_
 
size_t offset_
 

Friends

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);
}
See also
GenericReader::Parse, GenericDocument::Parse

Definition at line 101 of file error.h.

Constructor & Destructor Documentation

ParseResult::ParseResult ( )
inline

Default constructor, no error.

Definition at line 104 of file error.h.

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

Constructor to set an error.

Definition at line 106 of file error.h.

Member Function Documentation

void ParseResult::Clear ( )
inline

Reset error code.

Definition at line 123 of file error.h.

References kParseErrorNone, and Set().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ParseErrorCode ParseResult::Code ( ) const
inline

Get the error code.

Definition at line 109 of file error.h.

References code_.

bool ParseResult::IsError ( ) const
inline

Whether the result is an error.

Definition at line 116 of file error.h.

References code_, and kParseErrorNone.

+ Here is the caller graph for this function:

size_t ParseResult::Offset ( ) const
inline

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

Definition at line 111 of file error.h.

References offset_.

ParseResult::operator bool ( ) const
inline

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

Definition at line 114 of file error.h.

References IsError().

+ Here is the call graph for this function:

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

Definition at line 118 of file error.h.

References code_.

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

Definition at line 119 of file error.h.

References code_.

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

Update error code and offset.

Definition at line 125 of file error.h.

References code_, and offset_.

+ Here is the caller graph for this function:

Friends And Related Function Documentation

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

Definition at line 120 of file error.h.

Member Data Documentation

ParseErrorCode ParseResult::code_
private

Definition at line 128 of file error.h.

size_t ParseResult::offset_
private

Definition at line 129 of file error.h.


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