ReactOS  0.4.14-dev-998-g623dd26
zstd_errors.h File Reference
#include <stddef.h>
Include dependency graph for zstd_errors.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ZSTDERRORLIB_VISIBILITY
 
#define ZSTDERRORLIB_API   ZSTDERRORLIB_VISIBILITY
 

Enumerations

enum  ZSTD_ErrorCode {
  ZSTD_error_no_error = 0, ZSTD_error_GENERIC = 1, ZSTD_error_prefix_unknown = 10, ZSTD_error_version_unsupported = 12,
  ZSTD_error_frameParameter_unsupported = 14, ZSTD_error_frameParameter_windowTooLarge = 16, ZSTD_error_corruption_detected = 20, ZSTD_error_checksum_wrong = 22,
  ZSTD_error_dictionary_corrupted = 30, ZSTD_error_dictionary_wrong = 32, ZSTD_error_dictionaryCreation_failed = 34, ZSTD_error_parameter_unsupported = 40,
  ZSTD_error_parameter_outOfBound = 42, ZSTD_error_tableLog_tooLarge = 44, ZSTD_error_maxSymbolValue_tooLarge = 46, ZSTD_error_maxSymbolValue_tooSmall = 48,
  ZSTD_error_stage_wrong = 60, ZSTD_error_init_missing = 62, ZSTD_error_memory_allocation = 64, ZSTD_error_workSpace_tooSmall = 66,
  ZSTD_error_dstSize_tooSmall = 70, ZSTD_error_srcSize_wrong = 72, ZSTD_error_frameIndex_tooLarge = 100, ZSTD_error_seekableIO = 102,
  ZSTD_error_maxCode = 120
}
 

Functions

ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode (size_t functionResult)
 
ZSTDERRORLIB_API const charZSTD_getErrorString (ZSTD_ErrorCode code)
 

Macro Definition Documentation

◆ ZSTDERRORLIB_API

#define ZSTDERRORLIB_API   ZSTDERRORLIB_VISIBILITY

Definition at line 35 of file zstd_errors.h.

◆ ZSTDERRORLIB_VISIBILITY

#define ZSTDERRORLIB_VISIBILITY

Definition at line 27 of file zstd_errors.h.

Enumeration Type Documentation

◆ ZSTD_ErrorCode

Enumerator
ZSTD_error_no_error 
ZSTD_error_GENERIC 
ZSTD_error_prefix_unknown 
ZSTD_error_version_unsupported 
ZSTD_error_frameParameter_unsupported 
ZSTD_error_frameParameter_windowTooLarge 
ZSTD_error_corruption_detected 
ZSTD_error_checksum_wrong 
ZSTD_error_dictionary_corrupted 
ZSTD_error_dictionary_wrong 
ZSTD_error_dictionaryCreation_failed 
ZSTD_error_parameter_unsupported 
ZSTD_error_parameter_outOfBound 
ZSTD_error_tableLog_tooLarge 
ZSTD_error_maxSymbolValue_tooLarge 
ZSTD_error_maxSymbolValue_tooSmall 
ZSTD_error_stage_wrong 
ZSTD_error_init_missing 
ZSTD_error_memory_allocation 
ZSTD_error_workSpace_tooSmall 
ZSTD_error_dstSize_tooSmall 
ZSTD_error_srcSize_wrong 
ZSTD_error_frameIndex_tooLarge 
ZSTD_error_seekableIO 
ZSTD_error_maxCode 

Definition at line 52 of file zstd_errors.h.

52  {
75  /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */
78  ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */
ZSTD_ErrorCode
Definition: zstd_errors.h:52

Function Documentation

◆ ZSTD_getErrorCode()

ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode ( size_t  code)

ZSTD_getErrorCode() : convert a size_t function result into a ZSTD_ErrorCode enum type, which can be used to compare with enum list published above

ZSTD_getError() : convert a size_t function result into a proper ZSTD_errorCode enum

Definition at line 43 of file zstd_common.c.

43 { return ERR_getErrorCode(code); }
ERR_STATIC ERR_enum ERR_getErrorCode(size_t code)
Definition: error_private.h:58

Referenced by ZSTD_decompressMultiFrame().

◆ ZSTD_getErrorString()

ZSTDERRORLIB_API const char* ZSTD_getErrorString ( ZSTD_ErrorCode  code)

Same as ZSTD_getErrorName, but using a ZSTD_ErrorCode enum argument

ZSTD_getErrorString() : provides error code string from enum

Definition at line 47 of file zstd_common.c.

47 { return ERR_getErrorString(code); }
const char * ERR_getErrorString(ERR_enum code)
Definition: error_private.c:15