Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

regina::CompressionStream Class Reference
[General Utility Classes]

An output stream that compresses data as it is written. More...

#include <zstream.h>

List of all members.

Public Member Functions

 CompressionStream ()
 Creates a new compression stream.

 CompressionStream (const char *path)
 Creates a new compression stream that writes to the given file.

int open (const char *path)
 Opens the given file for compressed writing.

int close ()
 Closes the underlying file.


Detailed Description

An output stream that compresses data as it is written.

The standard zlib compression library is used.

This stream does its work through a CompressionBuffer.

Python:
Not present.


Constructor & Destructor Documentation

regina::CompressionStream::CompressionStream  )  [inline]
 

Creates a new compression stream.

regina::CompressionStream::CompressionStream const char *  path  )  [inline]
 

Creates a new compression stream that writes to the given file.

The underlying file will be opened automatically.

Parameters:
path the pathname of the new file to open.


Member Function Documentation

int regina::CompressionStream::close  )  [inline]
 

Closes the underlying file.

If no file is open, this routine does nothing.

Returns:
0 on success, or ZBuffer::zEOF on error.

int regina::CompressionStream::open const char *  path  )  [inline]
 

Opens the given file for compressed writing.

If a file is already open, it will be closed before the new file is opened.

Parameters:
path the pathname of the new file to open.
Returns:
0 on success, or ZBuffer::zEOF on error.


The documentation for this class was generated from the following file:
Copyright © 1999-2004, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).