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