zstd_ddict.c File Reference

#include "../common/allocations.h"
#include "../common/zstd_deps.h"
#include "../common/cpu.h"
#include "../common/mem.h"
#include "../common/fse.h"
#include "../common/huf.h"
#include "zstd_decompress_internal.h"
#include "zstd_ddict.h"

Data Structures
struct	ZSTD_DDict_s

Macros
#define	FSE_STATIC_LINKING_ONLY

Functions
const void *	ZSTD_DDict_dictContent (const ZSTD_DDict *ddict)
size_t	ZSTD_DDict_dictSize (const ZSTD_DDict *ddict)
void	ZSTD_copyDDictParameters (ZSTD_DCtx *dctx, const ZSTD_DDict *ddict)
ZSTD_DDict *	ZSTD_createDDict_advanced (const void *dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType, ZSTD_customMem customMem)
ZSTD_DDict *	ZSTD_createDDict (const void *dict, size_t dictSize)
ZSTD_DDict *	ZSTD_createDDict_byReference (const void *dictBuffer, size_t dictSize)
const ZSTD_DDict *	ZSTD_initStaticDDict (void *sBuffer, size_t sBufferSize, const void *dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType)
size_t	ZSTD_freeDDict (ZSTD_DDict *ddict)
size_t	ZSTD_estimateDDictSize (size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod)
size_t	ZSTD_sizeof_DDict (const ZSTD_DDict *ddict)
unsigned	ZSTD_getDictID_fromDDict (const ZSTD_DDict *ddict)

Macro Definition Documentation

FSE_STATIC_LINKING_ONLY

#define FSE_STATIC_LINKING_ONLY

Function Documentation

ZSTD_copyDDictParameters()

void ZSTD_copyDDictParameters	(	ZSTD_DCtx *	dctx,
		const ZSTD_DDict *	ddict )

ZSTD_createDDict()

ZSTD_DDict * ZSTD_createDDict	(	const void *	dict,
		size_t	dictSize )

ZSTD_createDDict() : Create a digested dictionary, to start decompression without startup delay. dict content is copied inside DDict. Consequently, dict can be released after ZSTD_DDict creation

ZSTD_createDDict_advanced()

ZSTD_DDict * ZSTD_createDDict_advanced	(	const void *	dict,
		size_t	dictSize,
		ZSTD_dictLoadMethod_e	dictLoadMethod,
		ZSTD_dictContentType_e	dictContentType,
		ZSTD_customMem	customMem )

ZSTD_createDDict_byReference()

ZSTD_DDict * ZSTD_createDDict_byReference	(	const void *	dictBuffer,
		size_t	dictSize )

ZSTD_createDDict_byReference() : Create a digested dictionary, to start decompression without startup delay. Dictionary content is simply referenced, it will be accessed during decompression. Warning : dictBuffer must outlive DDict (DDict must be freed before dictBuffer)

ZSTD_DDict_dictContent()

const void * ZSTD_DDict_dictContent

(

const ZSTD_DDict *

ddict

)

ZSTD_DDict_dictSize()

size_t ZSTD_DDict_dictSize

(

const ZSTD_DDict *

ddict

)

ZSTD_estimateDDictSize()

size_t ZSTD_estimateDDictSize	(	size_t	dictSize,
		ZSTD_dictLoadMethod_e	dictLoadMethod )

ZSTD_estimateDDictSize() : Estimate amount of memory that will be needed to create a dictionary for decompression. Note : dictionary created by reference using ZSTD_dlm_byRef are smaller

ZSTD_freeDDict()

size_t ZSTD_freeDDict

(

ZSTD_DDict *

ddict

)

ZSTD_freeDDict() : Function frees memory allocated with ZSTD_createDDict() If a NULL pointer is passed, no operation is performed.

ZSTD_getDictID_fromDDict()

unsigned ZSTD_getDictID_fromDDict

(

const ZSTD_DDict *

ddict

)

ZSTD_getDictID_fromDDict() : Provides the dictID of the dictionary loaded into ddict. If

Returns

== 0, the dictionary is not conformant to Zstandard specification, or empty. Non-conformant dictionaries can still be loaded, but as content-only dictionaries.

ZSTD_initStaticDDict()

const ZSTD_DDict * ZSTD_initStaticDDict	(	void *	sBuffer,
		size_t	sBufferSize,
		const void *	dict,
		size_t	dictSize,
		ZSTD_dictLoadMethod_e	dictLoadMethod,
		ZSTD_dictContentType_e	dictContentType )

ZSTD_sizeof_DDict()

size_t ZSTD_sizeof_DDict

(

const ZSTD_DDict *

ddict

)