zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT > Class Template Reference

Base class for zip ostreams. More...

#include <zipstream.hpp>

Inheritance diagram for zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >:

Public Types
typedef std::basic_ostream< Elem, Tr > &	ostream_reference
typedef basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >	zip_streambuf_type

Public Member Functions
	basic_zip_ostreambase (ostream_reference ostream_, size_t level_, EStrategy strategy_, size_t window_size_, size_t memory_level_, size_t buffer_size_)
	Construct a zip stream. More...
zip_streambuf_type *	rdbuf ()
	returns the underlying zip ostream object More...
int	get_zerr () const
	returns the zlib error state More...
uLong	get_crc () const
	returns the uncompressed data crc More...
uLong	get_out_size () const
	returns the compressed data size More...
uLong	get_in_size () const
	returns the uncompressed data size More...

Private Attributes
zip_streambuf_type	m_buf

Detailed Description

template<typename Elem, typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>
class zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >

Base class for zip ostreams.

Note

Contains a basic_zip_streambuf

Member Typedef Documentation

ostream_reference

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

typedef std::basic_ostream<Elem, Tr>& zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::ostream_reference

zip_streambuf_type

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

typedef basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT > zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::zip_streambuf_type

Constructor & Destructor Documentation

basic_zip_ostreambase()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::basic_zip_ostreambase ( ostream_reference  ostream_, size_t  level_, EStrategy  strategy_, size_t  window_size_, size_t  memory_level_, size_t  buffer_size_  )

inline

Construct a zip stream.

Note

More info on the following parameters can be found in the zlib documentation.

References basic::init(), and zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

Member Function Documentation

get_crc()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

uLong zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_crc ( ) const

inline

returns the uncompressed data crc

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_crc(), and zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

Referenced by utility::io::ozstream::get_crc().

get_in_size()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

uLong zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size ( ) const

inline

returns the uncompressed data size

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size(), and zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

Referenced by utility::io::ozstream::get_in_size().

get_out_size()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

uLong zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_out_size ( ) const

inline

returns the compressed data size

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_out_size(), and zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

Referenced by utility::io::ozstream::get_out_size().

get_zerr()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

int zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_zerr ( ) const

inline

returns the zlib error state

References zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

rdbuf()

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

zip_streambuf_type* zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::rdbuf ( )

inline

returns the underlying zip ostream object

References zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf.

Member Data Documentation

m_buf

template<typename Elem , typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>

zip_streambuf_type zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::m_buf

private

Referenced by zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::basic_zip_ostreambase(), zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_crc(), zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size(), zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_out_size(), zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_zerr(), and zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::rdbuf().

---

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

• src/utility/io/zipstream.hpp