byteme::ZlibBufferWriter Class Reference

Compress and write bytes to a Zlib-compressed buffer. More...

#include <ZlibBufferWriter.hpp>

Inheritance diagram for byteme::ZlibBufferWriter:

Collaboration diagram for byteme::ZlibBufferWriter:

Public Member Functions
	ZlibBufferWriter (const ZlibBufferWriterOptions &options)
void	write (const unsigned char *buffer, std::size_t n)
void	finish ()
std::vector< unsigned char > &	get_output ()
Public Member Functions inherited from byteme::Writer
virtual	~Writer ()=default

Detailed Description

Compress and write bytes to a Zlib-compressed buffer.

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

Constructor & Destructor Documentation

ZlibBufferWriter()

byteme::ZlibBufferWriter::ZlibBufferWriter ( const ZlibBufferWriterOptions & options )

inline

Parameters

options

Further options.

Member Function Documentation

finish()

void byteme::ZlibBufferWriter::finish ( )

inlinevirtual

Indicate that the writing has finished and that the relevant clean-up (buffer flushing, file closing, etc.) should be performed. This should be called exactly once, after which no further calls to write() or finish() should be performed.

Implements byteme::Writer.

get_output()

std::vector< unsigned char > & byteme::ZlibBufferWriter::get_output ( )

inline

Returns

Contents of the output buffer. This should only be used after finish() is called.

write()

void byteme::ZlibBufferWriter::write ( const unsigned char * buffer, std::size_t n )

inlinevirtual

Write the next chunk of bytes to the output sink. This may or may not be internally buffered at the discretion of the concrete class.

Parameters

[in]	buffer	Pointer to the start of an array containing the bytes to be written.
	n	Length of the array in buffer. This may be zero.

Implements byteme::Writer.

---

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

• byteme/ZlibBufferWriter.hpp