MRZlib.h File Reference

#include <MRCMisc/exports.h>

Go to the source code of this file.

Typedefs
typedef struct MR_expected_void_std_string	MR_expected_void_std_string
typedef struct MR_std_istream	MR_std_istream
typedef struct MR_std_ostream	MR_std_ostream

Functions
MRC_API MR_expected_void_std_string *	MR_zlibCompressStream (MR_std_istream *in, MR_std_ostream *out, const int *level)
	compress the input data using the Deflate algorithm
MRC_API MR_expected_void_std_string *	MR_zlibDecompressStream (MR_std_istream *in, MR_std_ostream *out)

Typedef Documentation

MR_expected_void_std_string

typedef struct MR_expected_void_std_string MR_expected_void_std_string

MR_std_istream

typedef struct MR_std_istream MR_std_istream

MR_std_ostream

typedef struct MR_std_ostream MR_std_ostream

Function Documentation

MR_zlibCompressStream()

MRC_API MR_expected_void_std_string * MR_zlibCompressStream	(	MR_std_istream *	in,
		MR_std_ostream *	out,
		const int *	level )

compress the input data using the Deflate algorithm

Parameters

in	- input data stream
out	- output data stream
level	- compression level (0 - no compression, 1 - the fastest but the most inefficient compression, 9 - the most efficient but the slowest compression)

Returns

nothing or error string Generated from function MR::zlibCompressStream. Parameter in can not be null. It is a single object. Parameter out can not be null. It is a single object. Parameter level has a default argument: -1, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.

MR_zlibDecompressStream()

MRC_API MR_expected_void_std_string * MR_zlibDecompressStream	(	MR_std_istream *	in,
		MR_std_ostream *	out )

/brief decompress the input data compressed using the Deflate algorithm

Parameters

in	- input data stream
out	- output data stream

Returns

nothing or error string Generated from function MR::zlibDecompressStream. Parameter in can not be null. It is a single object. Parameter out can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it.