Stream which compresses / uncompresses data using the 'deflate' compression algorithm.
More...
|
| DeflateStream (const DataStreamPtr &compressedStream, const String &tmpFileName="", size_t avail_in=0) |
| Constructor for creating unnamed stream wrapping another stream.
|
|
| DeflateStream (const String &name, const DataStreamPtr &compressedStream, const String &tmpFileName="", size_t avail_in=0) |
| Constructor for creating named stream wrapping another stream.
|
|
| DeflateStream (const String &name, const DataStreamPtr &compressedStream, StreamType streamType, const String &tmpFileName="", size_t avail_in=0) |
| Constructor for creating named stream wrapping another stream.
|
|
| ~DeflateStream () |
|
void | close (void) override |
| Close the stream; this makes further operations invalid.
|
|
bool | eof (void) const override |
| Returns true if the stream has reached the end.
|
|
bool | isCompressedStreamValid () const |
| Returns whether the compressed stream is valid deflated data.
|
|
size_t | read (void *buf, size_t count) override |
| Read the requisite number of bytes from the stream, stopping at the end of the file.
|
|
void | seek (size_t pos) override |
| Repositions the read point to a specified byte.
|
|
void | skip (long count) override |
| Skip a defined number of bytes.
|
|
size_t | tell (void) const override |
| Returns the current byte offset from beginning.
|
|
size_t | write (const void *buf, size_t count) override |
| Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)
|
|
| DataStream (const String &name, uint16 accessMode=READ) |
| Constructor for creating named streams.
|
|
| DataStream (uint16 accessMode=READ) |
| Constructor for creating unnamed streams.
|
|
virtual | ~DataStream () |
|
uint16 | getAccessMode () const |
| Gets the access mode of the stream.
|
|
virtual String | getAsString (void) |
| Returns a String containing the entire stream.
|
|
virtual String | getLine (bool trimAfter=true) |
| Returns a String containing the next line of data, optionally trimmed for whitespace.
|
|
const String & | getName (void) |
| Returns the name of the stream, if it has one.
|
|
virtual bool | isReadable () const |
| Reports whether this stream is readable.
|
|
virtual bool | isWriteable () const |
| Reports whether this stream is writeable.
|
|
template<typename T> |
DataStream & | operator>> (T &val) |
|
virtual size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") |
| Get a single line from the stream.
|
|
size_t | size (void) const |
| Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
|
|
virtual size_t | skipLine (const String &delim="\n") |
| Skip a single line from the stream.
|
|
Stream which compresses / uncompresses data using the 'deflate' compression algorithm.
This stream is designed to wrap another stream for the actual source / destination of the compressed data, it has no concrete source / data itself. The idea is that you pass uncompressed data through this stream, and the underlying stream reads/writes compressed data to the final source.
- Note
- This is an alternative to using a compressed archive since it is able to compress & decompress regardless of the actual source of the stream. You should avoid using this with already compressed archives. Also note that this cannot be used as a read / write stream, only a read-only or write-only stream.