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 >:

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_type *	byte_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. More...

	~basic_zip_streambuf () override

int	sync () override

int_type	overflow (int_type c) override

std::streamsize	flush ()
	flushes the zip buffer and output buffer More...

std::streamsize	flush_finalize ()
	flushes the zip buffer and output buffer and finalize the zip stream More...

void	reset_state ()
	resets the zip stream and zeros the crc More...

ostream_reference	get_ostream () const
	returns a reference to the output stream More...

int	get_zerr () const
	returns the latest zlib error status More...

uLong	get_crc () const
	returns the crc of the input data compressed so far More...

uLong	get_in_size () const
	returns the size (bytes) of the input data compressed so far More...

uLong	get_out_size () const
	returns the size (bytes) of the compressed data so far More...

Private Member Functions
bool	zip_to_stream (char_type *, std::streamsize)

size_t	fill_input_buffer ()

std::streamsize	flush (int flush_mode)
	flush the zip buffer using a particular mode and flush output buffer More...

Private Attributes
ostream_reference	m_ostream

z_stream	m_zip_stream

int	m_err

byte_vector_type	m_output_buffer

char_vector_type	m_buffer

uLong	m_crc

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

◆ 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 std::basic_streambuf< Elem, Tr > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::basic_streambuf_type

◆ 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 ByteAT zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_allocator_type

◆ 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 byte_type* zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_buffer_type

◆ 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 ByteT zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_type

◆ 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 std::vector< byte_type, byte_allocator_type > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::byte_vector_type

◆ 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 ElemA zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_allocator_type

◆ 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 Elem zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_type

◆ 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 std::vector< char_type, char_allocator_type > zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::char_vector_type

◆ 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 Tr::int_type zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::int_type

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

◆ traits_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 zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::traits_type

Constructor & Destructor Documentation

◆ basic_zip_streambuf()

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 zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_buffer, zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_err, zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_zip_stream, and min().

◆ ~basic_zip_streambuf()

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >

zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::~basic_zip_streambuf

override

Member Function Documentation

◆ fill_input_buffer()

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

size_t zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::fill_input_buffer ( )

private

◆ flush() [1/2]

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

Referenced by zlib_stream::basic_zip_ostream< Elem, Tr, ElemA, ByteT, ByteAT >::zflush().

◆ flush() [2/2]

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >

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

private

flush the zip buffer using a particular mode and flush output buffer

References numeric::remainder().

◆ flush_finalize()

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.

Referenced by zlib_stream::basic_zip_ostream< Elem, Tr, ElemA, ByteT, ByteAT >::zflush_finalize().

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

inline

returns the crc of the input data compressed so far

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_crc.

Referenced by zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size ( ) const

inline

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

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_zip_stream.

Referenced by zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size().

◆ get_ostream()

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

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_ostream.

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

inline

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

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_zip_stream.

Referenced by zlib_stream::basic_zip_ostreambase< Elem, Tr, ElemA, ByteT, ByteAT >::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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_zerr ( ) const

inline

returns the latest zlib error status

References zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_err.

◆ overflow()

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 )

override

◆ reset_state()

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() @deatils to allow future writes

Referenced by zlib_stream::basic_zip_ostream< Elem, Tr, ElemA, ByteT, ByteAT >::reset_zip_stream().

◆ sync()

template<typename Elem , typename Tr , typename ElemA , typename ByteT , typename ByteAT >

int zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::sync

override

◆ zip_to_stream()

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

bool zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::zip_to_stream	(	char_type *	,
		std::streamsize
	)

private

References numeric::remainder().

Member Data Documentation

◆ m_buffer

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

char_vector_type zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_buffer

private

Referenced by zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::basic_zip_streambuf().

◆ m_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_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_crc

private

Referenced by zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_crc().

◆ m_err

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 >::m_err

private

Referenced by zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::basic_zip_streambuf(), and zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_zerr().

◆ m_ostream

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 >::m_ostream

private

Referenced by zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_ostream().

◆ m_output_buffer

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

byte_vector_type zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_output_buffer

private

◆ m_zip_stream

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

z_stream zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::m_zip_stream

private

Referenced by zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::basic_zip_streambuf(), zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_in_size(), and zlib_stream::basic_zip_streambuf< Elem, Tr, ElemA, ByteT, ByteAT >::get_out_size().

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

src/utility/io/zipstream.hpp
src/utility/io/zipstream.ipp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

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 >

Member Typedef Documentation

◆ basic_streambuf_type

◆ byte_allocator_type

◆ byte_buffer_type

◆ byte_type

◆ byte_vector_type

◆ char_allocator_type

◆ char_type

◆ char_vector_type

◆ int_type

◆ ostream_reference

◆ traits_type

Constructor & Destructor Documentation

◆ basic_zip_streambuf()

◆ ~basic_zip_streambuf()

Member Function Documentation

◆ fill_input_buffer()

◆ flush() [1/2]

◆ flush() [2/2]

◆ flush_finalize()

◆ get_crc()

◆ get_in_size()

◆ get_ostream()

◆ get_out_size()

◆ get_zerr()

◆ overflow()

◆ reset_state()

◆ sync()

◆ zip_to_stream()

Member Data Documentation

◆ m_buffer

◆ m_crc

◆ m_err

◆ m_ostream

◆ m_output_buffer

◆ m_zip_stream

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 >