MRProgressReadWrite.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_function_bool_from_float	MR_std_function_bool_from_float
typedef struct MR_std_istream	MR_std_istream
typedef struct MR_std_ostream	MR_std_ostream

Functions
MRC_API bool	MR_writeByBlocks (MR_std_ostream *out, const char *data, MR_uint64_t dataSize, MR_PassBy callback_pass_by, MR_std_function_bool_from_float *callback, const MR_uint64_t *blockSize)
	write dataSize bytes from data to out stream by blocks blockSize bytes
MRC_API bool	MR_readByBlocks (MR_std_istream *in, char *data, MR_uint64_t dataSize, MR_PassBy callback_pass_by, MR_std_function_bool_from_float *callback, const MR_uint64_t *blockSize)
	read dataSize bytes from in stream to data by blocks blockSize bytes

Typedef Documentation

MR_std_function_bool_from_float

typedef struct MR_std_function_bool_from_float MR_std_function_bool_from_float

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_readByBlocks()

MRC_API bool MR_readByBlocks	(	MR_std_istream *	in,
		char *	data,
		MR_uint64_t	dataSize,
		MR_PassBy	callback_pass_by,
		MR_std_function_bool_from_float *	callback,
		const MR_uint64_t *	blockSize )

read dataSize bytes from in stream to data by blocks blockSize bytes

if progress callback is not set, read all data by one block

Returns

false if process was canceled (callback is set and return false ) Generated from function MR::readByBlocks. Parameter in can not be null. It is a single object. Parameter callback has a default argument: {}, pass MR_PassBy_DefaultArgument and a null pointer to use it. Parameter blockSize has a default argument: (size_t(1) << 16), pass a null pointer to use it.

MR_writeByBlocks()

MRC_API bool MR_writeByBlocks	(	MR_std_ostream *	out,
		const char *	data,
		MR_uint64_t	dataSize,
		MR_PassBy	callback_pass_by,
		MR_std_function_bool_from_float *	callback,
		const MR_uint64_t *	blockSize )

write dataSize bytes from data to out stream by blocks blockSize bytes

if progress callback is not set, write all data by one block

Returns

false if process was canceled (callback is set and return false ) Generated from function MR::writeByBlocks. Parameter out can not be null. It is a single object. Parameter callback has a default argument: {}, pass MR_PassBy_DefaultArgument and a null pointer to use it. Parameter blockSize has a default argument: (size_t(1) << 16), pass a null pointer to use it.