This stream will decompress a source-stream using zlib. More...
Inherits InputStream.
Public Member Functions | |
| GZIPDecompressorInputStream (InputStream *sourceStream, bool deleteSourceWhenDestroyed, bool noWrap=false, int64 uncompressedStreamLength=-1) | |
| Creates a decompressor stream. | |
| GZIPDecompressorInputStream (InputStream &sourceStream) | |
| Creates a decompressor stream. | |
| ~GZIPDecompressorInputStream () | |
| Destructor. | |
| int64 | getPosition () |
| Returns the offset of the next byte that will be read from the stream. | |
| bool | setPosition (int64 pos) |
| Tries to move the current read position of the stream. | |
| int64 | getTotalLength () |
| Returns the total number of bytes available for reading in this stream. | |
| bool | isExhausted () |
| Returns true if the stream has no more data to read. | |
| int | read (void *destBuffer, int maxBytesToRead) |
| Reads a set of bytes from the stream into a memory buffer. | |
This stream will decompress a source-stream using zlib.
Tip: if you're reading lots of small items from one of these streams, you can increase the performance enormously by passing it through a BufferedInputStream, so that it has to read larger blocks less often.
| GZIPDecompressorInputStream::GZIPDecompressorInputStream | ( | InputStream * | sourceStream, |
| bool | deleteSourceWhenDestroyed, | ||
| bool | noWrap = false, |
||
| int64 | uncompressedStreamLength = -1 |
||
| ) |
Creates a decompressor stream.
| sourceStream | the stream to read from |
| deleteSourceWhenDestroyed | whether or not to delete the source stream when this object is destroyed |
| noWrap | this is used internally by the ZipFile class and should be ignored by user applications |
| uncompressedStreamLength | if the creator knows the length that the uncompressed stream will be, then it can supply this value, which will be returned by getTotalLength() |
| GZIPDecompressorInputStream::GZIPDecompressorInputStream | ( | InputStream & | sourceStream ) |
Creates a decompressor stream.
| sourceStream | the stream to read from - the source stream must not be deleted until this object has been destroyed |
| GZIPDecompressorInputStream::~GZIPDecompressorInputStream | ( | ) |
Destructor.
| int64 GZIPDecompressorInputStream::getPosition | ( | ) | [virtual] |
Returns the offset of the next byte that will be read from the stream.
Implements InputStream.
| bool GZIPDecompressorInputStream::setPosition | ( | int64 | newPosition ) | [virtual] |
Tries to move the current read position of the stream.
The position is an absolute number of bytes from the stream's start.
Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.
Implements InputStream.
| int64 GZIPDecompressorInputStream::getTotalLength | ( | ) | [virtual] |
Returns the total number of bytes available for reading in this stream.
Note that this is the number of bytes available from the start of the stream, not from the current position.
If the size of the stream isn't actually known, this may return -1.
Implements InputStream.
| bool GZIPDecompressorInputStream::isExhausted | ( | ) | [virtual] |
Returns true if the stream has no more data to read.
Implements InputStream.
| int GZIPDecompressorInputStream::read | ( | void * | destBuffer, |
| int | maxBytesToRead | ||
| ) | [virtual] |
Reads a set of bytes from the stream into a memory buffer.
This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).
| destBuffer | the destination buffer for the data |
| maxBytesToRead | the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. |
Implements InputStream.
