This is the documentation for Enlighten.
class Geo GeoZLibFileStream
class Geo::GeoZLibFileStream
└>Geo::IGeoStream
└>Geo::IGeoInputStream
IGeoStream implementation that saves/loads data from a zlib compressed file.
Since we need the ability to seek backwards within a stream, we have to make an in-memory copy first and then upon close, push this to the disk. If reading, expand whole file, then read what we need. Note that the class will happily open files that were not compressed, and not complain. As a result, you can load a file saved with either GeoZLibFileStream or GeoFileStream using this class.
Functions
Name | Description |
|---|---|
Closes current file, if open. | |
Deleting a stream should behave like a close operation. | |
Deleting a stream should behave like a close operation. | |
Provide information about the typed data written to the stream. | |
Close current file, if any. | |
Provide information about the typed data written to the stream. | |
Create with no attached file. | |
Return the filename with which this stream was opened (not available if created with FILE*) | |
Return the position of the read/write pointer within the stream (prototype matches ftell) | |
Return the position of the read/write pointer within the stream (prototype matches ftell) | |
Return the position of the read/write pointer within the stream (prototype matches ftell) | |
Is the read pointer at the end of the file (as with feof, only returns true if you have read past end) | |
Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end) | |
Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end) | |
Tests if the stream is valid. | |
Tests if the stream is valid. | |
Tests if the stream is valid. | |
Close current file, if any, and open filename. | |
Read a fixed size array. | |
Read data (prototype matches fread). Prefer to use the templated Read methods. | |
Read a collection of objects, returning true on success. | |
Read data (prototype matches fread). Prefer to use the templated Read methods. | |
Read a single object, returning true on success. | |
Read a single object, returning true on success. | |
Read a single object, returning true on success. | |
Reads the stream to its end and returns the data as a char array. | |
Set the position of the read/write pointer within the stream (prototype matches fseek) | |
Set the position of the read/write pointer within the stream (prototype matches fseek) | |
Set the position of the read/write pointer within the stream (prototype matches fseek) | |
Write a fixed size array. | |
Write a collection of objects, in range [begin, end) as STL-style classes support. | |
Write data (prototype matches fwrite). Prefer to use the templated Write methods. | |
Write a single object, returning true on success. | |
Write data (prototype matches fwrite). Prefer to use the templated Write methods. |