#include <juce_GZIPCompressorOutputStream.h>
A stream which uses zlib to compress the data written into it.
Important note: When you call flush() on a GZIPCompressorOutputStream, the gzip data is closed - this means that no more data can be written to it, and any subsequent attempts to call write() will cause an assertion.
- See also
- GZIPDecompressorInputStream
◆ WindowBitsValues
These are preset values that can be used for the constructor's windowBits parameter. For more info about this, see the zlib documentation for its windowBits parameter.
Enumerator |
---|
windowBitsRaw | |
windowBitsGZIP | |
◆ GZIPCompressorOutputStream()
GZIPCompressorOutputStream::GZIPCompressorOutputStream |
( |
OutputStream * |
destStream, |
|
|
int |
compressionLevel = 0 , |
|
|
bool |
deleteDestStreamWhenDestroyed = false , |
|
|
int |
windowBits = 0 |
|
) |
| |
Creates a compression stream.
- Parameters
-
destStream | the stream into which the compressed data should be written |
compressionLevel | how much to compress the data, between 1 and 9, where 1 is the fastest/lowest compression, and 9 is the slowest/highest compression. Any value outside this range indicates that a default compression level should be used. |
deleteDestStreamWhenDestroyed | whether or not to delete the destStream object when this stream is destroyed |
windowBits | this is used internally to change the window size used by zlib - leave it as 0 unless you specifically need to set its value for some reason |
◆ ~GZIPCompressorOutputStream()
GZIPCompressorOutputStream::~GZIPCompressorOutputStream |
( |
| ) |
|
◆ flush()
void GZIPCompressorOutputStream::flush |
( |
| ) |
|
|
overridevirtual |
Flushes and closes the stream. Note that unlike most streams, when you call flush() on a GZIPCompressorOutputStream, the stream is closed - this means that no more data can be written to it, and any subsequent attempts to call write() will cause an assertion.
Implements OutputStream.
◆ getPosition()
int64 GZIPCompressorOutputStream::getPosition |
( |
| ) |
|
|
overridevirtual |
◆ setPosition()
bool GZIPCompressorOutputStream::setPosition |
( |
int64 |
newPosition | ) |
|
|
overridevirtual |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
- See also
- getPosition
Implements OutputStream.
◆ write()
bool GZIPCompressorOutputStream::write |
( |
const void * |
dataToWrite, |
|
|
size_t |
numberOfBytes |
|
) |
| |
|
overridevirtual |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
- Parameters
-
dataToWrite | the target buffer to receive the data. This must not be null. |
numberOfBytes | the number of bytes to write. |
- Returns
- false if the write operation fails for some reason
Implements OutputStream.
◆ ContainerDeletePolicy< GZIPCompressorHelper >
The documentation for this class was generated from the following files: