zbuff.h File Reference

#include <stddef.h>
#include "../zstd.h"

Go to the source code of this file.

Macros
#define	ZSTD_BUFFERED_H_23987
#define	ZBUFF_DEPRECATED(message)

Typedefs
typedef ZSTD_CStream	ZBUFF_CCtx
typedef ZSTD_DStream	ZBUFF_DCtx

Functions
	ZBUFF_DEPRECATED ("use ZSTD_createCStream") ZBUFF_CCtx *ZBUFF_createCCtx(void)
	ZBUFF_DEPRECATED ("use ZSTD_freeCStream") size_t ZBUFF_freeCCtx(ZBUFF_CCtx *cctx)
	ZBUFF_DEPRECATED ("use ZSTD_initCStream") size_t ZBUFF_compressInit(ZBUFF_CCtx *cctx
	ZBUFF_DEPRECATED ("use ZSTD_initCStream_usingDict") size_t ZBUFF_compressInitDictionary(ZBUFF_CCtx *cctx
	ZBUFF_DEPRECATED ("use ZSTD_compressStream") size_t ZBUFF_compressContinue(ZBUFF_CCtx *cctx
	ZBUFF_DEPRECATED ("use ZSTD_flushStream") size_t ZBUFF_compressFlush(ZBUFF_CCtx *cctx
	ZBUFF_DEPRECATED ("use ZSTD_endStream") size_t ZBUFF_compressEnd(ZBUFF_CCtx *cctx
	ZBUFF_DEPRECATED ("use ZSTD_createDStream") ZBUFF_DCtx *ZBUFF_createDCtx(void)
	ZBUFF_DEPRECATED ("use ZSTD_freeDStream") size_t ZBUFF_freeDCtx(ZBUFF_DCtx *dctx)
	ZBUFF_DEPRECATED ("use ZSTD_initDStream") size_t ZBUFF_decompressInit(ZBUFF_DCtx *dctx)
	ZBUFF_DEPRECATED ("use ZSTD_initDStream_usingDict") size_t ZBUFF_decompressInitDictionary(ZBUFF_DCtx *dctx
	ZBUFF_DEPRECATED ("use ZSTD_decompressStream") size_t ZBUFF_decompressContinue(ZBUFF_DCtx *dctx
	ZBUFF_DEPRECATED ("use ZSTD_isError") unsigned ZBUFF_isError(size_t errorCode)
	ZBUFF_DEPRECATED ("use ZSTD_getErrorName") const char *ZBUFF_getErrorName(size_t errorCode)
	ZBUFF_DEPRECATED ("use ZSTD_CStreamInSize") size_t ZBUFF_recommendedCInSize(void)
	ZBUFF_DEPRECATED ("use ZSTD_CStreamOutSize") size_t ZBUFF_recommendedCOutSize(void)
	ZBUFF_DEPRECATED ("use ZSTD_DStreamInSize") size_t ZBUFF_recommendedDInSize(void)
	ZBUFF_DEPRECATED ("use ZSTD_DStreamOutSize") size_t ZBUFF_recommendedDOutSize(void)

Variables
int	compressionLevel
const void *	dict
const void size_t	dictSize
void *	dst
void size_t *	dstCapacityPtr
void size_t const void *	src
void size_t const void size_t *	srcSizePtr

Macro Definition Documentation

ZBUFF_DEPRECATED

#define ZBUFF_DEPRECATED

(

message

)

Value:

ZSTDLIB_API

ZSTD_BUFFERED_H_23987

#define ZSTD_BUFFERED_H_23987

Typedef Documentation

ZBUFF_CCtx

typedef ZSTD_CStream ZBUFF_CCtx

ZBUFF_DCtx

typedef ZBUFFv04_DCtx ZBUFF_DCtx

Function Documentation

ZBUFF_DEPRECATED() [1/18]

ZBUFF_DEPRECATED

(

"use ZSTD_compressStream"

)

ZBUFF_DEPRECATED() [2/18]

ZBUFF_DEPRECATED

(

"use ZSTD_createCStream"

)

ZBUFF_DEPRECATED() [3/18]

ZBUFF_DEPRECATED

(

"use ZSTD_createDStream"

)

ZBUFF_DEPRECATED() [4/18]

ZBUFF_DEPRECATED

(

"use ZSTD_CStreamInSize"

)

Functions below provide recommended buffer sizes for Compression or Decompression operations. These sizes are just hints, they tend to offer better latency

ZBUFF_DEPRECATED() [5/18]

ZBUFF_DEPRECATED

(

"use ZSTD_CStreamOutSize"

)

ZBUFF_DEPRECATED() [6/18]

ZBUFF_DEPRECATED

(

"use ZSTD_decompressStream"

)

ZBUFF_DEPRECATED() [7/18]

ZBUFF_DEPRECATED

(

"use ZSTD_DStreamInSize"

)

ZBUFF_DEPRECATED() [8/18]

ZBUFF_DEPRECATED

(

"use ZSTD_DStreamOutSize"

)

ZBUFF_DEPRECATED() [9/18]

ZBUFF_DEPRECATED

(

"use ZSTD_endStream"

)

ZBUFF_DEPRECATED() [10/18]

ZBUFF_DEPRECATED

(

"use ZSTD_flushStream"

)

ZBUFF_DEPRECATED() [11/18]

ZBUFF_DEPRECATED

(

"use ZSTD_freeCStream"

)

ZBUFF_DEPRECATED() [12/18]

ZBUFF_DEPRECATED

(

"use ZSTD_freeDStream"

)

ZBUFF_DEPRECATED() [13/18]

ZBUFF_DEPRECATED

(

"use ZSTD_getErrorName"

)

const

ZBUFF_DEPRECATED() [14/18]

ZBUFF_DEPRECATED

(

"use ZSTD_initCStream"

)

ZBUFF_DEPRECATED() [15/18]

ZBUFF_DEPRECATED

(

"use ZSTD_initCStream_usingDict"

)

ZBUFF_DEPRECATED() [16/18]

ZBUFF_DEPRECATED

(

"use ZSTD_initDStream"

)

ZBUFF_DEPRECATED() [17/18]

ZBUFF_DEPRECATED

(

"use ZSTD_initDStream_usingDict"

)

ZBUFF_DEPRECATED() [18/18]

ZBUFF_DEPRECATED

(

"use ZSTD_isError"

)

Variable Documentation

compressionLevel

const void size_t int compressionLevel

dict

const void * dict

dictSize

const void size_t dictSize

dst

void* dst

dstCapacityPtr

void size_t * dstCapacityPtr

src

void size_t const void* src

srcSizePtr

void size_t const void size_t * srcSizePtr