byteme::GzipFileWriter Class Reference

Write uncompressed bytes to a Gzip-compressed file. More...

#include <GzipFileWriter.hpp>

Inheritance diagram for byteme::GzipFileWriter:

Collaboration diagram for byteme::GzipFileWriter:

Public Member Functions
	GzipFileWriter (const char *path, const GzipFileWriterOptions &options)
void	write (const unsigned char *buffer, std::size_t n)
void	finish ()
Public Member Functions inherited from byteme::Writer
virtual	~Writer ()=default

Detailed Description

Write uncompressed bytes to a Gzip-compressed file.

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

Constructor & Destructor Documentation

GzipFileWriter()

byteme::GzipFileWriter::GzipFileWriter ( const char * path, const GzipFileWriterOptions & options )

inline

Parameters

path	Path to the file.
options	Further options.

Member Function Documentation

finish()

void byteme::GzipFileWriter::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.

write()

void byteme::GzipFileWriter::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/GzipFileWriter.hpp