zstd_decompress.h File Reference

#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct dictionary_s	dictionary_t

Functions
size_t	ZSTD_decompress (void *const dst, const size_t dst_len, const void *const src, const size_t src_len)
size_t	ZSTD_decompress_with_dict (void *const dst, const size_t dst_len, const void *const src, const size_t src_len, dictionary_t *parsed_dict)
size_t	ZSTD_get_decompressed_size (const void *const src, const size_t src_len)
dictionary_t *	create_dictionary (void)
void	parse_dictionary (dictionary_t *const dict, const void *src, size_t src_len)
void	free_dictionary (dictionary_t *const dict)
	Free an allocated dictionary.

Typedef Documentation

dictionary_t

typedef struct dictionary_s dictionary_t

Function Documentation

create_dictionary()

dictionary_t * create_dictionary

(

void

)

free_dictionary()

void free_dictionary

(

dictionary_t *const

dict

)

Free an allocated dictionary.

parse_dictionary()

void parse_dictionary	(	dictionary_t *const	dict,
		const void *	src,
		size_t	src_len )

ZSTD_decompress()

size_t ZSTD_decompress	(	void *	dst,
		size_t	dstLen,
		const void *	src,
		size_t	srcLen )

Zstandard decompression functions. dst must point to a space at least as large as the reconstructed output.

For the case where the decompression library hasn't been included we add a dummy function to fake the process and stop the buffers being optimised out.

ZSTD_decompress_with_dict()

size_t ZSTD_decompress_with_dict	(	void *const	dst,
		const size_t	dst_len,
		const void *const	src,
		const size_t	src_len,
		dictionary_t *	parsed_dict )

If dict != NULL and dict_len >= 8, does the same thing as ZSTD_decompress but uses the provided dict

ZSTD_get_decompressed_size()

size_t ZSTD_get_decompressed_size	(	const void *	src,
		const size_t	src_len )

Get the decompressed size of an input stream so memory can be allocated in advance Returns -1 if the size can't be determined Assumes decompression of a single frame

Get the decompressed size of an input stream so memory can be allocated in advance. This implementation assumes src points to a single ZSTD-compressed frame