zstd_errors.h 3.1 KB

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