mio::GZstreambuf Class Reference

Detailed Description

A stream buffer for compressed (gzipped) file I/O using zlib with compression level 9.

#include <GZstream.h>

Public Member Functions
	GZstreambuf ()
	~GZstreambuf () override
bool	open (const std::string &filename, const char *mode)
	Open a gzipped file.
void	close ()
	Close the file.
bool	is_open () const
	Check if the stream is open.
std::streampos	tell () const
	Get the current position.

Protected Member Functions
virtual int_type	underflow () override
virtual int_type	pbackfail (int_type c) override
virtual std::streamsize	showmanyc () override
virtual std::streamsize	xsgetn (char_type *s, std::streamsize n) override
virtual int_type	overflow (int_type c) override
virtual int	sync () override
virtual std::streamsize	xsputn (const char_type *s, std::streamsize n) override

Constructor & Destructor Documentation

GZstreambuf()

mio::GZstreambuf::GZstreambuf

(

)

~GZstreambuf()

mio::GZstreambuf::~GZstreambuf ( )

override

Member Function Documentation

close()

void mio::GZstreambuf::close

(

)

Close the file.

is_open()

bool mio::GZstreambuf::is_open

(

)

const

Check if the stream is open.

open()

bool mio::GZstreambuf::open	(	const std::string &	filename,
		const char *	mode
	)

Open a gzipped file.

Parameters

filename	The file to open
mode	The gzopen mode ("rb" for read, "wb9" for write with best compression)

Returns

true on success

overflow()

GZstreambuf::int_type mio::GZstreambuf::overflow ( int_type  c )

overrideprotectedvirtual

pbackfail()

GZstreambuf::int_type mio::GZstreambuf::pbackfail ( int_type  c )

overrideprotectedvirtual

showmanyc()

std::streamsize mio::GZstreambuf::showmanyc ( )

overrideprotectedvirtual

sync()

int mio::GZstreambuf::sync ( )

overrideprotectedvirtual

tell()

std::streampos mio::GZstreambuf::tell

(

)

const

Get the current position.

underflow()

GZstreambuf::int_type mio::GZstreambuf::underflow ( )

overrideprotectedvirtual

xsgetn()

std::streamsize mio::GZstreambuf::xsgetn ( char_type *  s, std::streamsize  n  )

overrideprotectedvirtual

xsputn()

std::streamsize mio::GZstreambuf::xsputn ( const char_type *  s, std::streamsize  n  )

overrideprotectedvirtual

---

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

• GZstream.h
• GZstream.cc