Public Member Functions

gzifstream Class Reference

Gzipped file input stream class. More...

#include <zfstream.h>

Inheritance diagram for gzifstream:
Inheritance graph
[legend]
Collaboration diagram for gzifstream:
Collaboration graph
[legend]

Public Member Functions

 gzifstream (const char *name, int io_mode=ios::in)
 gzifstream (int fd, int io_mode=ios::in)
 gzifstream (const char *name, std::ios_base::openmode mode=std::ios_base::in)
 Construct stream on gzipped file to be opened.
 gzifstream (int fd, std::ios_base::openmode mode=std::ios_base::in)
 Construct stream on already open gzipped file.
gzfilebufrdbuf () const
bool is_open ()
 Check if file is open.
void open (const char *name, std::ios_base::openmode mode=std::ios_base::in)
 Open gzipped file.
void attach (int fd, std::ios_base::openmode mode=std::ios_base::in)
 Attach to already open gzipped file.
void close ()
 Close gzipped file.

Detailed Description

Gzipped file input stream class.

This class implements ifstream for gzipped files. Seeking and putback is not supported yet.

Definition at line 68 of file zfstream.h.


Constructor & Destructor Documentation

gzifstream ( const char *  name,
std::ios_base::openmode  mode = std::ios_base::in 
) [explicit]

Construct stream on gzipped file to be opened.

Parameters:
nameFile name.
modeOpen mode flags (forced to contain ios::in).
gzifstream ( int  fd,
std::ios_base::openmode  mode = std::ios_base::in 
) [explicit]

Construct stream on already open gzipped file.

Parameters:
fdFile descriptor.
modeOpen mode flags (forced to contain ios::in).

Member Function Documentation

void attach ( int  fd,
std::ios_base::openmode  mode = std::ios_base::in 
)

Attach to already open gzipped file.

Parameters:
fdFile descriptor.
modeOpen mode flags (forced to contain ios::in).

Stream will be in state good() if attach succeeded; otherwise in state fail().

void close (  )

Close gzipped file.

Stream will be in state fail() if close failed.

Reimplemented from gzfilestream_common.

bool is_open (  ) [inline]

Check if file is open.

Returns:
True if file is open.

Definition at line 270 of file zfstream.h.

void open ( const char *  name,
std::ios_base::openmode  mode = std::ios_base::in 
)

Open gzipped file.

Parameters:
nameFile name.
modeOpen mode flags (forced to contain ios::in).

Stream will be in state good() if file opens successfully; otherwise in state fail(). This differs from the behavior of ifstream, which never sets the state to good() and therefore won't allow you to reuse the stream for a second file unless you manually clear() the state. The choice is a matter of convenience.

gzfilebuf* rdbuf (  ) const [inline]

Obtain underlying stream buffer.

Definition at line 262 of file zfstream.h.


The documentation for this class was generated from the following files: