regina::DecompressionBuffer Class Reference
[General Utility Classes]

An input stream buffer that decompresses data as it is read. More...

#include <zstream.h>

Inheritance diagram for regina::DecompressionBuffer:

List of all members.

Public Member Functions

DecompressionBuffer ()

Creates a new decompression stream buffer.

DecompressionBuffer (const char *path)

Creates a new decompression stream buffer that reads from the given file.

int open (const char *path)

Opens the given file for decompressed reading.

Detailed Description

An input stream buffer that decompresses data as it is read.

The standard zlib compression library is used.

This buffer is designed for use with standard C++ I/O streams.

This stream buffer should not be used for output.

Python:: Not present.

Constructor & Destructor Documentation

regina::DecompressionBuffer::DecompressionBuffer ( ) [inline]

Creates a new decompression stream buffer.

regina::DecompressionBuffer::DecompressionBuffer ( const char * path ) [inline]

Creates a new decompression stream buffer that reads from the given file.

The underlying file will be opened automatically.

Internationalisation:: This routine makes no assumptions about the character encoding used in the given file name, and simply passes it through unchanged to low-level C/C++ file I/O routines.

Parameters:

path

the pathname of the new file to open.

Member Function Documentation

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

Opens the given file for decompressed reading.

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

Internationalisation:: This routine makes no assumptions about the character encoding used in the given file name, and simply passes it through unchanged to low-level C/C++ file I/O routines.