CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT > Class Template Reference

Input stream wrapper that transparently decompresses data read from an underlying compressed source stream. More...

#include <CompressionStreams.hpp>

Inheritance diagram for CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >:

Public Types
typedef StreamType::char_type	char_type
	The character type of the stream. More...
typedef StreamType::traits_type	traits_type
	The character traits type of the stream. More...
typedef StreamType::int_type	int_type
	The integer type used to represent characters and EOF. More...
typedef StreamType::pos_type	pos_type
	The type used to represent stream positions. More...
typedef StreamType::off_type	off_type
	The type used to represent stream offsets. More...
Public Types inherited from CDPL::Util::CompressionStreamBase< CompAlgo, std::basic_istream< char, std::char_traits< char > > >
typedef StreamType::char_type	char_type
	The character type of the wrapped stream. More...
typedef StreamType::traits_type	traits_type
	The character traits type of the wrapped stream. More...
typedef StreamType::int_type	int_type
	The integer type used to represent characters and EOF. More...
typedef StreamType::pos_type	pos_type
	The type used to represent stream positions. More...
typedef StreamType::off_type	off_type
	The type used to represent stream offsets. More...
typedef std::basic_istream< char_type, traits_type >	IStreamType
	Input-stream type with matching character and traits types. More...
typedef std::basic_ostream< char_type, traits_type >	OStreamType
	Output-stream type with matching character and traits types. More...

Public Member Functions
	DecompressionIStream ()
	Constructs the DecompressionIStream instance without an associated source stream. More...
	DecompressionIStream (StreamType &stream)
	Constructs the DecompressionIStream instance and immediately opens it on stream. More...
void	open (StreamType &stream)
	Opens the decompression stream on stream. More...
void	close ()
	Closes the decompression stream and releases the temporary buffer. More...
Public Member Functions inherited from CDPL::Util::CompressionStreamBase< CompAlgo, std::basic_istream< char, std::char_traits< char > > >
	CompressionStreamBase ()
	Constructs the CompressionStreamBase instance and installs the temporary-file buffer. More...

Additional Inherited Members
Protected Member Functions inherited from CDPL::Util::CompressionStreamBase< CompAlgo, std::basic_istream< char, std::char_traits< char > > >
virtual	~CompressionStreamBase ()
void	closeTmpFile ()
void	openTmpFile ()
void	decompInput (IStreamType &is)
void	compOutput (OStreamType &os)

Detailed Description

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>
class CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >

Input stream wrapper that transparently decompresses data read from an underlying compressed source stream.

Template Parameters

CompAlgo	The compression algorithm identifier (see Util::CompressionAlgo).
CharT	The character type of the stream.
TraitsT	The character traits type of the stream.

Member Typedef Documentation

char_type

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>

typedef StreamType::char_type CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::char_type

The character type of the stream.

traits_type

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>

typedef StreamType::traits_type CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::traits_type

The character traits type of the stream.

int_type

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>

typedef StreamType::int_type CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::int_type

The integer type used to represent characters and EOF.

pos_type

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>

typedef StreamType::pos_type CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::pos_type

The type used to represent stream positions.

off_type

template<CompressionAlgo CompAlgo, typename CharT = char, typename TraitsT = std::char_traits<CharT>>

typedef StreamType::off_type CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::off_type

The type used to represent stream offsets.

Constructor & Destructor Documentation

DecompressionIStream() [1/2]

template<CDPL::Util::CompressionAlgo CompAlgo, typename CharT , typename TraitsT >

CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::DecompressionIStream

Constructs the DecompressionIStream instance without an associated source stream.

DecompressionIStream() [2/2]

template<CDPL::Util::CompressionAlgo CompAlgo, typename CharT , typename TraitsT >

CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::DecompressionIStream

(

StreamType &

stream

)

Constructs the DecompressionIStream instance and immediately opens it on stream.

Parameters

stream

The compressed source stream to read from.

Member Function Documentation

open()

template<CDPL::Util::CompressionAlgo CompAlgo, typename CharT , typename TraitsT >

void CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::open

(

StreamType &

stream

)

Opens the decompression stream on stream.

Parameters

stream

The compressed source stream to read from.

close()

template<CDPL::Util::CompressionAlgo CompAlgo, typename CharT , typename TraitsT >

void CDPL::Util::DecompressionIStream< CompAlgo, CharT, TraitsT >::close

Closes the decompression stream and releases the temporary buffer.

---

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

• CompressionStreams.hpp