byteme::Reader Class Reference

Virtual class for reading bytes from a source. More...

#include <Reader.hpp>

Inheritance diagram for byteme::Reader:

Public Member Functions
virtual std::size_t	read (unsigned char *buffer, std::size_t n)=0

Detailed Description

Virtual class for reading bytes from a source.

Member Function Documentation

read()

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

pure virtual

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.

Implemented in byteme::GzipFileReader, byteme::IstreamReader< Pointer_ >, byteme::RawBufferReader, byteme::RawFileReader, and byteme::ZlibBufferReader.

---

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

• byteme/Reader.hpp