error.hpp

//
// Copyright (c) 2015-2016 Vinnie Falco (vinnie dot falco at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

#ifndef NUDB_ERROR_HPP
#define NUDB_ERROR_HPP

#include <boost/system/system_error.hpp>
#include <boost/system/error_code.hpp>

namespace nudb {

/// The type of system-specific error code returned by the implementation
#if GENERATING_DOCS
class error_code{};

#else
using boost::system::error_code;

#endif

/// The type of cross-platform error code used by the implementation
#if GENERATING_DOCS
class error_condition{};

#else
using boost::system::error_condition;

#endif

/// The type of system-specific exception used when throwing
#if GENERATING_DOCS
class system_error{};

#else
using boost::system::system_error;

#endif

/// Returns the  category used for system-specific error codes
#if GENERATING_DOCS
error_category const&
system_category();

#else
using boost::system::system_category;

#endif

/// Returns the category used for cross-platform error codes
#if GENERATING_DOCS
error_category const&
generic_category();

#else
using boost::system::generic_category;

#endif

/// The base class used for error categories
#if GENERATING_DOCS
class error_category{};

#else
using boost::system::error_category;

#endif

/// The set of constants used for cross-platform error codes
#if GENERATING_DOCS
enum errc{};

#else
namespace errc = boost::system::errc;

#endif

/// Database error codes.
enum class error
{
    /** The specified key was not found.

        Returned when @ref basic_store::fetch does not
        find the specified key.
    */
    key_not_found,

    /** The specified key already exists.

        Returned when @ref basic_store::insert finds
        the specified key already in the database.
    */
    key_exists,

    /** A file read returned less data than expected.

        This can be caused by premature application
        termination during a commit cycle.
    */
    short_read,

    /** A log file is present.

        Indicates that the database needs to have the
        associated log file applied to perform a recovery.
        This error is returned by functions such as @ref rekey.
    */
    log_file_exists,

    /** No key file exists.

        This error is returned by the recover process when
        there is no valid key file. It happens when a
        @ref rekey operation prematurely terminates. A
        database without a key file cannot be opened. To
        fix this error, it is necessary for an invocation of
        @ref rekey to complete successfully.
    */
    no_key_file,

    /// Too many buckets in key file
    too_many_buckets,

    /// Not a data file
    not_data_file,

    /// Not a key file
    not_key_file,

    /// Not a log file
    not_log_file,

    /// Different version
    different_version,

    /// Invalid key size
    invalid_key_size,

    /// Invalid block size
    invalid_block_size,

    /// Short key file
    short_key_file,

    /// Short bucket
    short_bucket,

    /// Short spill
    short_spill,

    /// Short record
    short_data_record,

    /// Short value
    short_value,

    /// Hash mismatch
    hash_mismatch,

    /// Invalid load factor
    invalid_load_factor,

    /// Invalid capacity
    invalid_capacity,

    /// Invalid bucket count
    invalid_bucket_count,

    /// Invalid bucket size
    invalid_bucket_size,

    /// The data file header was incomplete
    incomplete_data_file_header,

    /// The key file header was incomplete
    incomplete_key_file_header,

    /// Invalid log record
    invalid_log_record,

    /// Invalid spill in log record
    invalid_log_spill,

    /// Invalid offset in log record
    invalid_log_offset,

    /// Invalid index in log record
    invalid_log_index,

    /// Invalid size in spill
    invalid_spill_size,

    /// UID mismatch
    uid_mismatch,

    /// appnum mismatch
    appnum_mismatch,

    /// key size mismatch
    key_size_mismatch,

    /// salt mismatch
    salt_mismatch,

    /// pepper mismatch
    pepper_mismatch,

    /// block size mismatch
    block_size_mismatch,

    /// orphaned value
    orphaned_value,

    /// missing value
    missing_value,

    /// size mismatch
    size_mismatch,

    /// duplicate value
    duplicate_value,

    /// directory not found
    dir_not_found
};

/// Returns the error category used for database error codes.
error_category const&
nudb_category();

/** Returns a database error code.

    This function is used by the implementation to convert
    @ref error values into @ref error_code objects.
*/
inline
error_code
make_error_code(error ev)
{
    return error_code{static_cast<int>(ev), nudb_category()};
}

} // nudb

namespace boost {
namespace system {
template<>
struct is_error_code_enum<nudb::error>
{
    static bool const value = true;
};
} // system
} // boost

#include <nudb/impl/error.ipp>

#endif