Rosetta 3.3
Public Types | Public Member Functions
zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT > Class Template Reference

A stream decorator that takes raw input and zips it to a ostream. More...

#include <zipstream.hpp>

Inheritance diagram for zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >:
Inheritance graph
[legend]
Collaboration diagram for zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::basic_streambuf
< Elem, Tr > 
basic_streambuf_type
typedef std::basic_ostream
< Elem, Tr > & 
ostream_reference
typedef Elem char_type
typedef ElemA char_allocator_type
typedef ByteT byte_type
typedef ByteAT byte_allocator_type
typedef byte_typebyte_buffer_type
typedef std::vector< byte_type,
byte_allocator_type
byte_vector_type
typedef std::vector< char_type,
char_allocator_type
char_vector_type
typedef Tr traits_type
typedef Tr::int_type int_type

Public Member Functions

 basic_zip_streambuf (ostream_reference ostream_, size_t level_, EStrategy strategy_, size_t window_size_, size_t memory_level_, size_t buffer_size_)
 Construct a zip stream.
 ~basic_zip_streambuf ()
int sync ()
int_type overflow (int_type c)
 OVERFLOW.
std::streamsize flush ()
 flushes the zip buffer and output buffer
std::streamsize flush_finalize ()
 flushes the zip buffer and output buffer and finalize the zip stream
void reset_state ()
 resets the zip stream and zeros the crc
ostream_reference get_ostream () const
 returns a reference to the output stream
int get_zerr () const
 returns the latest zlib error status
uLong get_crc () const
 returns the crc of the input data compressed so far
uLong get_in_size () const
 returns the size (bytes) of the input data compressed so far
uLong get_out_size () const
 returns the size (bytes) of the compressed data so far

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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >

A stream decorator that takes raw input and zips it to a ostream.

Note:
The class wraps up the inflate method of the zlib library 1.1.4 http://www.gzip.org/zlib/

Member Typedef Documentation

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_streambuf< Elem, Tr > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::basic_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 ByteAT zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_allocator_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 byte_type* zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_buffer_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 ByteT zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_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 std::vector< byte_type, byte_allocator_type > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_vector_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 ElemA zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_allocator_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 Elem zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_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 std::vector< char_type, char_allocator_type > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_vector_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 Tr::int_type zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::int_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 std::basic_ostream< Elem, Tr >& zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::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 Tr zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::traits_type

Constructor & Destructor Documentation

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

Construct a zip stream.

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

References basic::options::OptionKeys::ddg::min.

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >
zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::~basic_zip_streambuf ( )

Member Function Documentation

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >
std::streamsize zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::flush ( )

flushes the zip buffer and output buffer

References basic::options::OptionKeys::dna::design::flush.

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >
std::streamsize zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::flush_finalize ( )

flushes the zip buffer and output buffer and finalize the zip stream

This method should be called at the end of the compression.

References basic::options::OptionKeys::dna::design::flush.

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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_crc ( ) const [inline]

returns the crc of the input data compressed so far

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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size ( ) const [inline]

returns the size (bytes) of the input data compressed so far

template<typename Elem, typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>
ostream_reference zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_ostream ( ) const [inline]

returns a reference to the output stream

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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_out_size ( ) const [inline]

returns the size (bytes) of the compressed data so far

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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_zerr ( ) const [inline]

returns the latest zlib error status

template<typename Elem, typename Tr = std::char_traits< Elem >, typename ElemA = std::allocator< Elem >, typename ByteT = unsigned char, typename ByteAT = std::allocator< ByteT >>
basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::int_type zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::overflow ( int_type  c)

OVERFLOW.

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >
void zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::reset_state ( )

resets the zip stream and zeros the crc

This method should be called after flush_finalize() to allow future writes

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >
int zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::sync ( )

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines