lz4file.h File Reference

#include <stdio.h>
#include "lz4frame_static.h"

Include dependency graph for lz4file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	LZ4FILE_H

Typedefs
typedef struct LZ4_readFile_s	LZ4_readFile_t
typedef struct LZ4_writeFile_s	LZ4_writeFile_t

Functions
LZ4FLIB_STATIC_API size_t	LZ4F_read (LZ4_readFile_t *lz4fRead, void *buf, size_t size)
LZ4FLIB_STATIC_API LZ4F_errorCode_t	LZ4F_readClose (LZ4_readFile_t *lz4fRead)
LZ4FLIB_STATIC_API LZ4F_errorCode_t	LZ4F_readOpen (LZ4_readFile_t **lz4fRead, FILE *fp)
LZ4FLIB_STATIC_API size_t	LZ4F_write (LZ4_writeFile_t *lz4fWrite, void *buf, size_t size)
LZ4FLIB_STATIC_API LZ4F_errorCode_t	LZ4F_writeClose (LZ4_writeFile_t *lz4fWrite)
LZ4FLIB_STATIC_API LZ4F_errorCode_t	LZ4F_writeOpen (LZ4_writeFile_t **lz4fWrite, FILE *fp, const LZ4F_preferences_t *prefsPtr)

Macro Definition Documentation

LZ4FILE_H

#define LZ4FILE_H

Definition at line 39 of file lz4file.h.

Typedef Documentation

LZ4_readFile_t

typedef struct LZ4_readFile_s LZ4_readFile_t

Definition at line 44 of file lz4file.h.

LZ4_writeFile_t

typedef struct LZ4_writeFile_s LZ4_writeFile_t

Definition at line 45 of file lz4file.h.

Function Documentation

LZ4F_read()

LZ4FLIB_STATIC_API size_t LZ4F_read	(	LZ4_readFile_t *	lz4fRead,
		void *	buf,
		size_t	size
	)

LZ4F_read() : Read lz4file content to buffer. lz4f must use LZ4_readOpen to set first. buf read data buffer. size read data buffer size.

Definition at line 126 of file lz4file.c.

LZ4F_readClose()

LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_readClose

(

LZ4_readFile_t *

lz4fRead

)

LZ4F_readClose() : Close lz4file handle. lz4f must use LZ4_readOpen to set first.

Definition at line 171 of file lz4file.c.

LZ4F_readOpen()

LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_readOpen	(	LZ4_readFile_t **	lz4fRead,
		FILE *	fp
	)

LZ4F_readOpen() : Set read lz4file handle. lz4f will set a lz4file handle. fp must be the return value of the lz4 file opened by fopen.

Definition at line 57 of file lz4file.c.

LZ4F_write()

LZ4FLIB_STATIC_API size_t LZ4F_write	(	LZ4_writeFile_t *	lz4fWrite,
		void *	buf,
		size_t	size
	)

LZ4F_write() : Write buffer to lz4file. lz4f must use LZ4F_writeOpen to set first. buf write data buffer. size write data buffer size.

Definition at line 250 of file lz4file.c.

LZ4F_writeClose()

LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_writeClose

(

LZ4_writeFile_t *

lz4fWrite

)

LZ4F_writeClose() : Close lz4file handle. lz4f must use LZ4F_writeOpen to set first.

Definition at line 286 of file lz4file.c.

LZ4F_writeOpen()

LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_writeOpen	(	LZ4_writeFile_t **	lz4fWrite,
		FILE *	fp,
		const LZ4F_preferences_t *	prefsPtr
	)

LZ4F_writeOpen() : Set write lz4file handle. lz4f will set a lz4file handle. fp must be the return value of the lz4 file opened by fopen.

Definition at line 181 of file lz4file.c.