2bd6440be0
Note : all error codes are changed by this new version, but it's expected to be the last change for existing codes. Codes are now grouped by category, and receive a manually attributed value. The objective is to guarantee that error code values will not change in the future when introducing new codes. Intentionnal empty spaces and ranges are defined in order to keep room for potential new codes.
82 lines
3.0 KiB
C
82 lines
3.0 KiB
C
/**
|
|
* Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#ifndef ZSTD_ERRORS_H_398273423
|
|
#define ZSTD_ERRORS_H_398273423
|
|
|
|
#if defined (__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*===== dependency =====*/
|
|
#include <stddef.h> /* size_t */
|
|
|
|
|
|
/* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */
|
|
#ifndef ZSTDERRORLIB_VISIBILITY
|
|
# if defined(__GNUC__) && (__GNUC__ >= 4)
|
|
# define ZSTDERRORLIB_VISIBILITY __attribute__ ((visibility ("default")))
|
|
# else
|
|
# define ZSTDERRORLIB_VISIBILITY
|
|
# endif
|
|
#endif
|
|
#if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
|
|
# define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBILITY
|
|
#elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
|
|
# define ZSTDERRORLIB_API __declspec(dllimport) ZSTDERRORLIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
|
|
#else
|
|
# define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY
|
|
#endif
|
|
|
|
/*-****************************************
|
|
* error codes list
|
|
* note : this API is still considered unstable
|
|
* and shall not be used with a dynamic library.
|
|
* only static linking is allowed
|
|
******************************************/
|
|
typedef enum {
|
|
ZSTD_error_no_error = 0,
|
|
ZSTD_error_GENERIC = 1,
|
|
ZSTD_error_prefix_unknown = 10,
|
|
ZSTD_error_version_unsupported = 12,
|
|
ZSTD_error_frameParameter_unsupported = 14,
|
|
ZSTD_error_frameParameter_windowTooLarge = 16,
|
|
ZSTD_error_corruption_detected = 20,
|
|
ZSTD_error_checksum_wrong = 22,
|
|
ZSTD_error_dictionary_corrupted = 30,
|
|
ZSTD_error_dictionary_wrong = 32,
|
|
ZSTD_error_dictionaryCreation_failed = 34,
|
|
ZSTD_error_parameter_unsupported = 40,
|
|
ZSTD_error_parameter_outOfBound = 42,
|
|
ZSTD_error_tableLog_tooLarge = 44,
|
|
ZSTD_error_maxSymbolValue_tooLarge = 46,
|
|
ZSTD_error_maxSymbolValue_tooSmall = 48,
|
|
ZSTD_error_stage_wrong = 60,
|
|
ZSTD_error_init_missing = 62,
|
|
ZSTD_error_memory_allocation = 64,
|
|
ZSTD_error_dstSize_tooSmall = 70,
|
|
ZSTD_error_srcSize_wrong = 72,
|
|
ZSTD_error_frameIndex_tooLarge = 100,
|
|
ZSTD_error_seekableIO = 102,
|
|
ZSTD_error_maxCode = 120 /* never EVER use this value directly, it may change in future versions! Use ZSTD_isError() instead */
|
|
} ZSTD_ErrorCode;
|
|
|
|
/*! ZSTD_getErrorCode() :
|
|
convert a `size_t` function result into a `ZSTD_ErrorCode` enum type,
|
|
which can be used to compare with enum list published above */
|
|
ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult);
|
|
ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /*< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */
|
|
|
|
|
|
#if defined (__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZSTD_ERRORS_H_398273423 */
|