gzofstream Class Reference

Gzipped file output stream class. More...

#include <zfstream.h>

Inheritance diagram for gzofstream:

Public Member Functions
	gzofstream ()
	gzofstream (const char *name, int io_mode=ios::out)
	gzofstream (int fd, int io_mode=ios::out)
virtual	~gzofstream ()
	gzofstream ()
	gzofstream (const char *name, std::ios_base::openmode mode=std::ios_base::out)
	Construct stream on gzipped file to be opened. More...
	gzofstream (int fd, std::ios_base::openmode mode=std::ios_base::out)
	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::out)
	Open gzipped file. More...
void	attach (int fd, std::ios_base::openmode mode=std::ios_base::out)
	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 output stream class.

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

Definition at line 80 of file zfstream.h.

Constructor & Destructor Documentation

gzofstream() [1/6]

gzofstream::gzofstream

(

)

Definition at line 311 of file zfstream.cpp.

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

gzofstream() [2/6]

gzofstream::gzofstream	(	const char *	name,
		int	io_mode = ios::out
	)

Definition at line 317 of file zfstream.cpp.

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

References gzfilestream_common::open().

gzofstream() [3/6]

gzofstream::gzofstream	(	int	fd,
		int	io_mode = ios::out
	)

Definition at line 323 of file zfstream.cpp.

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

References gzfilestream_common::attach(), and fd.

~gzofstream()

gzofstream::~gzofstream ( )

virtual

Definition at line 329 of file zfstream.cpp.

{ }

gzofstream() [4/6]

gzofstream::gzofstream

(

)

gzofstream() [5/6]

gzofstream::gzofstream ( const char *  name, std::ios_base::openmode  mode = std::ios_base::out  )

explicit

Construct stream on gzipped file to be opened.

Parameters

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

Definition at line 434 of file zfstream.cc.

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

References init, open(), and sb.

gzofstream() [6/6]

gzofstream::gzofstream ( int  fd, std::ios_base::openmode  mode = std::ios_base::out  )

explicit

Construct stream on already open gzipped file.

Parameters

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

Definition at line 443 of file zfstream.cc.

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

References attach(), init, and sb.

Member Function Documentation

attach()

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

Attach to already open gzipped file.

Parameters

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

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

Definition at line 464 of file zfstream.cc.

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

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

Referenced by gzofstream().

close()

void gzofstream::close

(

)

Close gzipped file.

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

Definition at line 475 of file zfstream.cc.

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

References gzfilebuf::close(), and sb.

Referenced by main().

is_open()

bool gzofstream::is_open ( )

inline

Check if file is open.

Returns

True if file is open.

Definition at line 359 of file zfstream.h.

{ return sb.is_open(); }

References gzfilebuf::is_open(), and sb.

open()

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

Open gzipped file.

Parameters

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

Stream will be in state good() if file opens successfully; otherwise in state fail(). This differs from the behavior of ofstream, 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 453 of file zfstream.cc.

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

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

Referenced by gzofstream().

rdbuf()

gzfilebuf* gzofstream::rdbuf ( ) const

inline

Obtain underlying stream buffer.

Definition at line 351 of file zfstream.h.

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

References sb.

Referenced by setcompression().

Member Data Documentation

sb

gzfilebuf gzofstream::sb

private

Underlying stream buffer.

Definition at line 401 of file zfstream.h.

Referenced by attach(), close(), gzofstream(), 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