sharpetronics/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-12-20 00:02:54 -05:00
Code Issues Projects Releases Wiki Activity

added clarification comments in zstd_errors.h

Browse Source 
answering some points in #1018
This commit is contained in:
Yann Collet 2018-02-20 12:54:49 -08:00
parent 7117ea8bec
commit 70163bf0d3
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/common/zstd_errors.h
View File

@ -35,12 +35,20 @@ extern "C" {
# define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY # define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY
#endif #endif
/*-**************************************** /*-*********************************************
* error codes list * Error codes list
* note : this API is still considered unstable *-*********************************************
* and shall not be used with a dynamic library. * Error codes _values_ are pinned down since v1.3.1 only.
* only static linking is allowed * Therefore, don't rely on values if you may link to any version < v1.3.1.
******************************************/ *
* Only values < 100 are considered stable.
*
* note 1 : this API shall be used with static linking only.
* dynamic linking is not yet officially supported.
* note 2 : Prefer relying on the enum than on its value whenever possible
* This is the only supported way to use the error list < v1.3.1
* note 3 : ZSTD_isError() is always correct, whatever the library version.
**********************************************/
typedef enum { typedef enum {
ZSTD_error_no_error = 0, ZSTD_error_no_error = 0,
ZSTD_error_GENERIC = 1, ZSTD_error_GENERIC = 1,
@ -63,7 +71,7 @@ typedef enum {
ZSTD_error_memory_allocation = 64, ZSTD_error_memory_allocation = 64,
ZSTD_error_dstSize_tooSmall = 70, ZSTD_error_dstSize_tooSmall = 70,
ZSTD_error_srcSize_wrong = 72, ZSTD_error_srcSize_wrong = 72,
/* following error codes are not stable and may be removed or changed in a future version */ /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */
ZSTD_error_frameIndex_tooLarge = 100, ZSTD_error_frameIndex_tooLarge = 100,
ZSTD_error_seekableIO = 102, ZSTD_error_seekableIO = 102,
ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */ ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */