zstd_common.c File Reference

#include "zstd_deps.h"
#include "error_private.h"
#include "zstd_internal.h"

Macros
#define	ZSTD_DEPS_NEED_MALLOC

Functions
unsigned	ZSTD_versionNumber (void)
const char *	ZSTD_versionString (void)
unsigned	ZSTD_isError (size_t code)
const char *	ZSTD_getErrorName (size_t code)
ZSTD_ErrorCode	ZSTD_getErrorCode (size_t code)
const char *	ZSTD_getErrorString (ZSTD_ErrorCode code)
void *	ZSTD_customMalloc (size_t size, ZSTD_customMem customMem)
void *	ZSTD_customCalloc (size_t size, ZSTD_customMem customMem)
void	ZSTD_customFree (void *ptr, ZSTD_customMem customMem)

Macro Definition Documentation

ZSTD_DEPS_NEED_MALLOC

#define ZSTD_DEPS_NEED_MALLOC

Function Documentation

ZSTD_customCalloc()

void * ZSTD_customCalloc	(	size_t	size,
		ZSTD_customMem	customMem )

ZSTD_customFree()

void ZSTD_customFree	(	void *	ptr,
		ZSTD_customMem	customMem )

ZSTD_customMalloc()

void * ZSTD_customMalloc	(	size_t	size,
		ZSTD_customMem	customMem )

ZSTD_getErrorCode()

ZSTD_ErrorCode ZSTD_getErrorCode

(

size_t

code

)

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

ZSTD_getErrorName()

const char * ZSTD_getErrorName

(

size_t

code

)

ZSTD_getErrorName() : provides error code string from function result (useful for debugging)

ZSTD_getErrorString()

const char * ZSTD_getErrorString

(

ZSTD_ErrorCode

code

)

ZSTD_getErrorString() : provides error code string from enum

ZSTD_isError()

unsigned ZSTD_isError

(

size_t

code

)

ZSTD_isError() : tells if a return value is an error code symbol is required for external callers

ZSTD_versionNumber()

unsigned ZSTD_versionNumber

(

void

)

ZSTD_versionNumber() : Return runtime library version, the value is (MAJOR*100*100 + MINOR*100 + RELEASE).

ZSTD_versionString()

const char * ZSTD_versionString

(

void

)

ZSTD_versionString() : Return runtime library version, like "1.4.5". Requires v1.3.0+.