Kyoto Cabinet
Public Types | Public Member Functions | Static Public Member Functions
kyotocabinet::BasicDB::Error Class Reference

Error data. More...

#include <kcdb.h>

List of all members.

Public Types

enum  Code {
  SUCCESS, NOIMPL, INVALID, NOREPOS,
  NOPERM, BROKEN, DUPREC, NOREC,
  LOGIC, SYSTEM, MISC = 15
}
 Error codes. More...

Public Member Functions

 Error ()
 Default constructor.
 Error (const Error &src)
 Copy constructor.
 Error (Code code, const char *message)
 Constructor.
 ~Error ()
 Destructor.
void set (Code code, const char *message)
 Set the error information.
Code code () const
 Get the error code.
const char * name () const
 Get the readable string of the code.
const char * message () const
 Get the supplement message.
Erroroperator= (const Error &right)
 Assignment operator from the self type.
 operator int32_t () const
 Cast operator to integer.

Static Public Member Functions

static const char * codename (Code code)
 Get the readable string of an error code.

Detailed Description

Error data.


Member Enumeration Documentation

Error codes.

Enumerator:
SUCCESS 

success

NOIMPL 

not implemented

INVALID 

invalid operation

NOREPOS 

no repository

NOPERM 

no permission

BROKEN 

broken file

DUPREC 

record duplication

NOREC 

no record

LOGIC 

logical inconsistency

SYSTEM 

system error

MISC 

miscellaneous error


Constructor & Destructor Documentation

Default constructor.

Copy constructor.

Parameters:
srcthe source object.
kyotocabinet::BasicDB::Error::Error ( Code  code,
const char *  message 
) [explicit]

Constructor.

Parameters:
codean error code.
messagea supplement message.

Destructor.


Member Function Documentation

void kyotocabinet::BasicDB::Error::set ( Code  code,
const char *  message 
)

Set the error information.

Parameters:
codean error code.
messagea supplement message.

Get the error code.

Returns:
the error code.
const char* kyotocabinet::BasicDB::Error::name ( ) const

Get the readable string of the code.

Returns:
the readable string of the code.

Get the supplement message.

Returns:
the supplement message.
static const char* kyotocabinet::BasicDB::Error::codename ( Code  code) [static]

Get the readable string of an error code.

Parameters:
codethe error code.
Returns:
the readable string of the error code.
Error& kyotocabinet::BasicDB::Error::operator= ( const Error right)

Assignment operator from the self type.

Parameters:
rightthe right operand.
Returns:
the reference to itself.
kyotocabinet::BasicDB::Error::operator int32_t ( ) const

Cast operator to integer.

Returns:
the error code.