Read bytes from a file, usually text. More...

Inheritance diagram for byteme::RawFileReader:

Collaboration diagram for byteme::RawFileReader:

Public Member Functions
	RawFileReader (const char *path, const RawFileReaderOptions &options)

std::size_t	read (unsigned char *buffer, std::size_t n)

Public Member Functions inherited from byteme::Reader

Detailed Description

Read bytes from a file, usually text.

This is basically a simple wrapper around std::FILE structures, with correct closing and error checking.

Constructor & Destructor Documentation

byteme::RawFileReader::RawFileReader	(	const char *	path,
		const RawFileReaderOptions &	options )

inline

Parameters

path	Path to the file.
options	Further options.

std::size_t byteme::RawFileReader::read	(	unsigned char *	buffer,
		std::size_t	n )

inlinevirtual

Read the specified number of bytes from the source into a user-supplied buffer.

Parameters

[out]	buffer	Pointer to an array of at least length `n`.
	n	Maximum number of bytes to extract from the source. This may be zero.

Returns: Number of bytes that were actually extracted from the source. This will be less than or equal to n. If less than n, the stream of bytes from the source is finished and no more calls to read() should be performed.

The documentation for this class was generated from the following file: