byteme::ZlibBufferReader Class Reference

Read and decompress bytes from a Zlib-compressed buffer. More...

#include <ZlibBufferReader.hpp>

Inheritance diagram for byteme::ZlibBufferReader:

Collaboration diagram for byteme::ZlibBufferReader:

Public Member Functions
	ZlibBufferReader (const unsigned char *buffer, size_t length, int mode=3, size_t buffer_size=65536)
bool	load ()
const unsigned char *	buffer () const
size_t	available () const
Public Member Functions inherited from byteme::Reader

Detailed Description

Read and decompress bytes from a Zlib-compressed buffer.

This is basically a wrapper around Zlib's inflate method, with correct closing and error checking.

Constructor & Destructor Documentation

ZlibBufferReader()

byteme::ZlibBufferReader::ZlibBufferReader ( const unsigned char * buffer, size_t length, int mode = 3, size_t buffer_size = 65536 )

inline

Parameters

buffer	Pointer to an array containing the compressed data.
length	Length of the buffer array.
mode	Compression of the stream - DEFLATE (0), Zlib (1) or Gzip (2). Default of 3 will auto-detect between Zlib and Gzip based on the headers.
buffer_size	Size of the buffer to use for reading.

Member Function Documentation

available()

size_t byteme::ZlibBufferReader::available ( ) const

inlinevirtual

This method should only be called after load() has been called and returns true. The return value is generally expected to be positive; however, it is possible to return a zero. Note that zero values should not be interpreted as the end of the source, which is strictly only defined by load() returning false.

Returns

Number of available bytes in buffer().

Implements byteme::Reader.

buffer()

const unsigned char * byteme::ZlibBufferReader::buffer ( ) const

inlinevirtual

This method should only be called after load() has been called and returns true.

Returns

Pointer to the start of an array containing the available bytes. The number of available bytes is provided in available().

Implements byteme::Reader.

load()

bool byteme::ZlibBufferReader::load ( )

inlinevirtual

Read the next chunk of bytes from the input source. To read the entire source, this function should be called repeatedly until false is returned.

Returns

Boolean indicating whether the read was successful. If false, it can be assumed that the end of the source was reached.

Implements byteme::Reader.

---

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

• byteme/ZlibBufferReader.hpp