gzifstream Class Reference

Gzipped file input stream class. More...

#include <zfstream.h>

Inheritance diagram for gzifstream:

Public Member Functions
	gzifstream ()
	gzifstream (const char *name, int io_mode=ios::in)
	gzifstream (int fd, int io_mode=ios::in)
virtual	~gzifstream ()
	gzifstream ()
	gzifstream (const char *name, std::ios_base::openmode mode=std::ios_base::in)
	Construct stream on gzipped file to be opened. More...
	gzifstream (int fd, std::ios_base::openmode mode=std::ios_base::in)
	Construct stream on already open gzipped file. More...
gzfilebuf *	rdbuf () const
bool	is_open ()
	Check if file is open. More...
void	open (const char *name, std::ios_base::openmode mode=std::ios_base::in)
	Open gzipped file. More...
void	attach (int fd, std::ios_base::openmode mode=std::ios_base::in)
	Attach to already open gzipped file. More...
void	close ()
	Close gzipped file. More...
Public Member Functions inherited from gzfilestream_common
virtual	~gzfilestream_common ()
void	attach (int fd, int io_mode)
void	open (const char *name, int io_mode)
void	close ()

Private Attributes
gzfilebuf	sb

Additional Inherited Members
Protected Member Functions inherited from gzfilestream_common
	gzfilestream_common ()

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() [1/6]

gzifstream::gzifstream

(

)

Definition at line 291 of file zfstream.cpp.

                       :
  ios( gzfilestream_common::rdbuf() )
{
  clear( ios::badbit );
}

gzifstream() [2/6]

gzifstream::gzifstream	(	const char *	name,
		int	io_mode = ios::in
	)

Definition at line 297 of file zfstream.cpp.

                                                      :
  ios( gzfilestream_common::rdbuf() )
{
  gzfilestream_common::open( name, io_mode );
}

References gzfilestream_common::open().

gzifstream() [3/6]

gzifstream::gzifstream	(	int	fd,
		int	io_mode = ios::in
	)

Definition at line 303 of file zfstream.cpp.

                                            :
  ios( gzfilestream_common::rdbuf() )
{
  gzfilestream_common::attach( fd, io_mode );
}

References gzfilestream_common::attach(), and fd.

~gzifstream()

gzifstream::~gzifstream ( )

virtual

Definition at line 309 of file zfstream.cpp.

{ }

gzifstream() [4/6]

gzifstream::gzifstream

(

)

gzifstream() [5/6]

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

explicit

Construct stream on gzipped file to be opened.

Parameters

name	File name.
mode	Open mode flags (forced to contain ios::in).

Definition at line 379 of file zfstream.cc.

: std::istream(NULL), sb()
{
  this->init(&sb);
  this->open(name, mode);
}

References init, open(), and sb.

gzifstream() [6/6]

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

explicit

Construct stream on already open gzipped file.

Parameters

fd	File descriptor.
mode	Open mode flags (forced to contain ios::in).

Definition at line 388 of file zfstream.cc.

: std::istream(NULL), sb()
{
  this->init(&sb);
  this->attach(fd, mode);
}

References attach(), init, and sb.

Member Function Documentation

attach()

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

Attach to already open gzipped file.

Parameters

fd	File descriptor.
mode	Open mode flags (forced to contain ios::in).

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

Definition at line 409 of file zfstream.cc.

{
  if (!sb.attach(fd, mode | std::ios_base::in))
    this->setstate(std::ios_base::failbit);
  else
    this->clear();
}

References gzfilebuf::attach(), fd, in, and sb.

Referenced by gzifstream().

close()

void gzifstream::close

(

)

Close gzipped file.

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

Definition at line 420 of file zfstream.cc.

{
  if (!sb.close())
    this->setstate(std::ios_base::failbit);
}

References gzfilebuf::close(), and sb.

is_open()

bool gzifstream::is_open ( )

inline

Check if file is open.

Returns

True if file is open.

Definition at line 270 of file zfstream.h.

{ return sb.is_open(); }

References gzfilebuf::is_open(), and sb.

open()

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

Open gzipped file.

Parameters

name	File name.
mode	Open 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.

Definition at line 398 of file zfstream.cc.

{
  if (!sb.open(name, mode | std::ios_base::in))
    this->setstate(std::ios_base::failbit);
  else
    this->clear();
}

References in, gzfilebuf::open(), and sb.

Referenced by gzifstream().

rdbuf()

gzfilebuf* gzifstream::rdbuf ( ) const

inline

Obtain underlying stream buffer.

Definition at line 262 of file zfstream.h.

  { return const_cast<gzfilebuf*>(&sb); }

References sb.

Member Data Documentation

sb

gzfilebuf gzifstream::sb

private

Underlying stream buffer.

Definition at line 312 of file zfstream.h.

Referenced by attach(), close(), gzifstream(), is_open(), open(), and rdbuf().

---

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

• subprojects/zlib-1.2.12/contrib/iostream/zfstream.h
• subprojects/zlib-1.2.12/contrib/iostream/zfstream.cpp
• subprojects/zlib-1.2.12/contrib/iostream3/zfstream.cc