1 /* 2 * Copyright (c) Yann Collet, Facebook, Inc. 3 * All rights reserved. 4 * 5 * This source code is licensed under both the BSD-style license (found in the 6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found 7 * in the COPYING file in the root directory of this source tree). 8 * You may select, at your option, one of the above-listed licenses. 9 */ 10 11 #ifndef ZSTD_ERRORS_H_398273423 12 #define ZSTD_ERRORS_H_398273423 13 14 /*===== dependency =====*/ 15 #include <linux/types.h> /* size_t */ 16 17 /* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */ 18 #define ZSTDERRORLIB_VISIBILITY 19 #define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY 20 21 /*-********************************************* 22 * Error codes list 23 *-********************************************* 24 * Error codes _values_ are pinned down since v1.3.1 only. 25 * Therefore, don't rely on values if you may link to any version < v1.3.1. 26 * 27 * Only values < 100 are considered stable. 28 * 29 * note 1 : this API shall be used with static linking only. 30 * dynamic linking is not yet officially supported. 31 * note 2 : Prefer relying on the enum than on its value whenever possible 32 * This is the only supported way to use the error list < v1.3.1 33 * note 3 : ZSTD_isError() is always correct, whatever the library version. 34 **********************************************/ 35 typedef enum { 36 ZSTD_error_no_error = 0, 37 ZSTD_error_GENERIC = 1, 38 ZSTD_error_prefix_unknown = 10, 39 ZSTD_error_version_unsupported = 12, 40 ZSTD_error_frameParameter_unsupported = 14, 41 ZSTD_error_frameParameter_windowTooLarge = 16, 42 ZSTD_error_corruption_detected = 20, 43 ZSTD_error_checksum_wrong = 22, 44 ZSTD_error_dictionary_corrupted = 30, 45 ZSTD_error_dictionary_wrong = 32, 46 ZSTD_error_dictionaryCreation_failed = 34, 47 ZSTD_error_parameter_unsupported = 40, 48 ZSTD_error_parameter_outOfBound = 42, 49 ZSTD_error_tableLog_tooLarge = 44, 50 ZSTD_error_maxSymbolValue_tooLarge = 46, 51 ZSTD_error_maxSymbolValue_tooSmall = 48, 52 ZSTD_error_stage_wrong = 60, 53 ZSTD_error_init_missing = 62, 54 ZSTD_error_memory_allocation = 64, 55 ZSTD_error_workSpace_tooSmall= 66, 56 ZSTD_error_dstSize_tooSmall = 70, 57 ZSTD_error_srcSize_wrong = 72, 58 ZSTD_error_dstBuffer_null = 74, 59 /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */ 60 ZSTD_error_frameIndex_tooLarge = 100, 61 ZSTD_error_seekableIO = 102, 62 ZSTD_error_dstBuffer_wrong = 104, 63 ZSTD_error_srcBuffer_wrong = 105, 64 ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */ 65 } ZSTD_ErrorCode; 66 67 /*! ZSTD_getErrorCode() : 68 convert a `size_t` function result into a `ZSTD_ErrorCode` enum type, 69 which can be used to compare with enum list published above */ 70 ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult); 71 ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /*< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */ 72 73 #endif /* ZSTD_ERRORS_H_398273423 */ 74