You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

zstd_errors.h 3.1KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /*
  2. * Copyright (c) 2016-present, 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. #if defined (__cplusplus)
  13. extern "C" {
  14. #endif
  15. /*===== dependency =====*/
  16. #include <stddef.h> /* size_t */
  17. /* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */
  18. #ifndef ZSTDERRORLIB_VISIBILITY
  19. # if defined(__GNUC__) && (__GNUC__ >= 4)
  20. # define ZSTDERRORLIB_VISIBILITY __attribute__ ((visibility ("default")))
  21. # else
  22. # define ZSTDERRORLIB_VISIBILITY
  23. # endif
  24. #endif
  25. #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
  26. # define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBILITY
  27. #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
  28. # 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.*/
  29. #else
  30. # define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY
  31. #endif
  32. /*-****************************************
  33. * error codes list
  34. * note : this API is still considered unstable
  35. * and shall not be used with a dynamic library.
  36. * only static linking is allowed
  37. ******************************************/
  38. typedef enum {
  39. ZSTD_error_no_error = 0,
  40. ZSTD_error_GENERIC = 1,
  41. ZSTD_error_prefix_unknown = 10,
  42. ZSTD_error_version_unsupported = 12,
  43. ZSTD_error_frameParameter_unsupported = 14,
  44. ZSTD_error_frameParameter_windowTooLarge = 16,
  45. ZSTD_error_corruption_detected = 20,
  46. ZSTD_error_checksum_wrong = 22,
  47. ZSTD_error_dictionary_corrupted = 30,
  48. ZSTD_error_dictionary_wrong = 32,
  49. ZSTD_error_dictionaryCreation_failed = 34,
  50. ZSTD_error_parameter_unsupported = 40,
  51. ZSTD_error_parameter_outOfBound = 42,
  52. ZSTD_error_tableLog_tooLarge = 44,
  53. ZSTD_error_maxSymbolValue_tooLarge = 46,
  54. ZSTD_error_maxSymbolValue_tooSmall = 48,
  55. ZSTD_error_stage_wrong = 60,
  56. ZSTD_error_init_missing = 62,
  57. ZSTD_error_memory_allocation = 64,
  58. ZSTD_error_dstSize_tooSmall = 70,
  59. ZSTD_error_srcSize_wrong = 72,
  60. ZSTD_error_frameIndex_tooLarge = 100,
  61. ZSTD_error_seekableIO = 102,
  62. ZSTD_error_maxCode = 120 /* never EVER use this value directly, it may change in future versions! Use ZSTD_isError() instead */
  63. } ZSTD_ErrorCode;
  64. /*! ZSTD_getErrorCode() :
  65. convert a `size_t` function result into a `ZSTD_ErrorCode` enum type,
  66. which can be used to compare with enum list published above */
  67. ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult);
  68. ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /**< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */
  69. #if defined (__cplusplus)
  70. }
  71. #endif
  72. #endif /* ZSTD_ERRORS_H_398273423 */