lz4frame.h File Reference

#include <stddef.h>

Go to the source code of this file.

Classes
struct	LZ4F_frameInfo_t
struct	LZ4F_preferences_t
struct	LZ4F_compressOptions_t
struct	LZ4F_decompressOptions_t

Macros
#define	LZ4F_VERSION   100

Typedefs
typedef size_t	LZ4F_errorCode_t
typedef void *	LZ4F_compressionContext_t
typedef void *	LZ4F_decompressionContext_t

Enumerations
enum	blockSizeID_t {   LZ4F_default =0, max64KB =4, max256KB =5, max1MB =6,   max4MB =7 }
enum	blockMode_t { blockLinked =0, blockIndependent }
enum	contentChecksum_t { noContentChecksum =0, contentChecksumEnabled }

Functions
unsigned	LZ4F_isError (LZ4F_errorCode_t code)
const char *	LZ4F_getErrorName (LZ4F_errorCode_t code)
size_t	LZ4F_compressFrameBound (size_t srcSize, const LZ4F_preferences_t *preferencesPtr)
size_t	LZ4F_compressFrame (void *dstBuffer, size_t dstMaxSize, const void *srcBuffer, size_t srcSize, const LZ4F_preferences_t *preferencesPtr)
LZ4F_errorCode_t	LZ4F_createCompressionContext (LZ4F_compressionContext_t *LZ4F_compressionContextPtr, unsigned version)
LZ4F_errorCode_t	LZ4F_freeCompressionContext (LZ4F_compressionContext_t LZ4F_compressionContext)
size_t	LZ4F_compressBegin (LZ4F_compressionContext_t compressionContext, void *dstBuffer, size_t dstMaxSize, const LZ4F_preferences_t *preferencesPtr)
size_t	LZ4F_compressBound (size_t srcSize, const LZ4F_preferences_t *preferencesPtr)
size_t	LZ4F_compressUpdate (LZ4F_compressionContext_t compressionContext, void *dstBuffer, size_t dstMaxSize, const void *srcBuffer, size_t srcSize, const LZ4F_compressOptions_t *compressOptionsPtr)
size_t	LZ4F_flush (LZ4F_compressionContext_t compressionContext, void *dstBuffer, size_t dstMaxSize, const LZ4F_compressOptions_t *compressOptionsPtr)
size_t	LZ4F_compressEnd (LZ4F_compressionContext_t compressionContext, void *dstBuffer, size_t dstMaxSize, const LZ4F_compressOptions_t *compressOptionsPtr)
LZ4F_errorCode_t	LZ4F_createDecompressionContext (LZ4F_decompressionContext_t *ctxPtr, unsigned version)
LZ4F_errorCode_t	LZ4F_freeDecompressionContext (LZ4F_decompressionContext_t ctx)
size_t	LZ4F_getFrameInfo (LZ4F_decompressionContext_t ctx, LZ4F_frameInfo_t *frameInfoPtr, const void *srcBuffer, size_t *srcSizePtr)
size_t	LZ4F_decompress (LZ4F_decompressionContext_t ctx, void *dstBuffer, size_t *dstSizePtr, const void *srcBuffer, size_t *srcSizePtr, const LZ4F_decompressOptions_t *optionsPtr)

Macro Definition Documentation

#define LZ4F_VERSION   100

Definition at line 115 of file lz4frame.h.

Typedef Documentation

typedef void* LZ4F_compressionContext_t

Definition at line 106 of file lz4frame.h.

typedef void* LZ4F_decompressionContext_t

Definition at line 183 of file lz4frame.h.

typedef size_t LZ4F_errorCode_t

Definition at line 57 of file lz4frame.h.

Enumeration Type Documentation

enum blockMode_t

Enumerator
blockLinked
blockIndependent

Definition at line 67 of file lz4frame.h.

enum blockSizeID_t

Enumerator
LZ4F_default
max64KB
max256KB
max1MB
max4MB

Definition at line 66 of file lz4frame.h.

enum contentChecksum_t

Enumerator
noContentChecksum
contentChecksumEnabled

Definition at line 68 of file lz4frame.h.

Function Documentation

size_t LZ4F_compressBegin	(	LZ4F_compressionContext_t	compressionContext,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const LZ4F_preferences_t *	preferencesPtr
	)

Definition at line 362 of file lz4frame.c.

size_t LZ4F_compressBound	(	size_t	srcSize,
		const LZ4F_preferences_t *	preferencesPtr
	)

Definition at line 437 of file lz4frame.c.

size_t LZ4F_compressEnd	(	LZ4F_compressionContext_t	compressionContext,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const LZ4F_compressOptions_t *	compressOptionsPtr
	)

Definition at line 671 of file lz4frame.c.

size_t LZ4F_compressFrame	(	void *	dstBuffer,
		size_t	dstMaxSize,
		const void *	srcBuffer,
		size_t	srcSize,
		const LZ4F_preferences_t *	preferencesPtr
	)

Definition at line 259 of file lz4frame.c.

size_t LZ4F_compressFrameBound	(	size_t	srcSize,
		const LZ4F_preferences_t *	preferencesPtr
	)

Definition at line 220 of file lz4frame.c.

size_t LZ4F_compressUpdate	(	LZ4F_compressionContext_t	compressionContext,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const void *	srcBuffer,
		size_t	srcSize,
		const LZ4F_compressOptions_t *	compressOptionsPtr
	)

Definition at line 519 of file lz4frame.c.

LZ4F_errorCode_t LZ4F_createCompressionContext	(	LZ4F_compressionContext_t *	LZ4F_compressionContextPtr,
		unsigned	version
	)

Definition at line 328 of file lz4frame.c.

LZ4F_errorCode_t LZ4F_createDecompressionContext	(	LZ4F_decompressionContext_t *	ctxPtr,
		unsigned	version
	)

Definition at line 711 of file lz4frame.c.

size_t LZ4F_decompress	(	LZ4F_decompressionContext_t	ctx,
		void *	dstBuffer,
		size_t *	dstSizePtr,
		const void *	srcBuffer,
		size_t *	srcSizePtr,
		const LZ4F_decompressOptions_t *	optionsPtr
	)

Definition at line 949 of file lz4frame.c.

size_t LZ4F_flush	(	LZ4F_compressionContext_t	compressionContext,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const LZ4F_compressOptions_t *	compressOptionsPtr
	)

Definition at line 628 of file lz4frame.c.

LZ4F_errorCode_t LZ4F_freeCompressionContext

(

LZ4F_compressionContext_t

LZ4F_compressionContext)

Definition at line 344 of file lz4frame.c.

LZ4F_errorCode_t LZ4F_freeDecompressionContext

(

LZ4F_decompressionContext_t

ctx)

Definition at line 723 of file lz4frame.c.

const char* LZ4F_getErrorName

(

LZ4F_errorCode_t

code)

Definition at line 169 of file lz4frame.c.

size_t LZ4F_getFrameInfo	(	LZ4F_decompressionContext_t	ctx,
		LZ4F_frameInfo_t *	frameInfoPtr,
		const void *	srcBuffer,
		size_t *	srcSizePtr
	)

Definition at line 825 of file lz4frame.c.

unsigned LZ4F_isError

(

LZ4F_errorCode_t

code)

Definition at line 164 of file lz4frame.c.