Public Member Functions | List of all members
zorba::transcode::stream< StreamType > Class Template Reference

A transcode::stream is used to wrap a C++ standard I/O stream with a transcode::streambuf so that transcoding and the management of the streambuf happens automatically. More...

#include <zorba/transcode_stream.h>

Inherits StreamType.

Public Member Functions

 stream (char const *charset)
 Constructs a transcode::stream. More...
 
template<typename StreamArgType >
 stream (char const *charset, StreamArgType stream_arg)
 Constructs a stream. More...
 
template<typename StreamArgType >
 stream (char const *charset, StreamArgType stream_arg, std::ios_base::openmode mode)
 Constructs a transcode::stream. More...
 

Detailed Description

template<class StreamType>
class zorba::transcode::stream< StreamType >

A transcode::stream is used to wrap a C++ standard I/O stream with a transcode::streambuf so that transcoding and the management of the streambuf happens automatically.

A transcode::stream is useful for streams created by you.

Template Parameters
StreamTypeThe I/O stream class type to wrap. It must be a concrete stream class.

Definition at line 259 of file transcode_stream.h.

Constructor & Destructor Documentation

template<class StreamType >
zorba::transcode::stream< StreamType >::stream ( char const *  charset)
inline

Constructs a transcode::stream.

Parameters
charsetThe name of the character encoding to convert from/to.
Exceptions
std::invalid_argumentif charset is not supported.

Definition at line 267 of file transcode_stream.h.

template<class StreamType >
template<typename StreamArgType >
zorba::transcode::stream< StreamType >::stream ( char const *  charset,
StreamArgType  stream_arg 
)
inline

Constructs a stream.

Template Parameters
StreamArgTypeThe type of the first argument of StreamType's constructor.
Parameters
charsetThe name of the character encoding to convert from/to.
stream_argThe argument to pass as the first argument to StreamType's constructor.
Exceptions
std::invalid_argumentif charset is not supported.

Definition at line 291 of file transcode_stream.h.

template<class StreamType >
template<typename StreamArgType >
zorba::transcode::stream< StreamType >::stream ( char const *  charset,
StreamArgType  stream_arg,
std::ios_base::openmode  mode 
)
inline

Constructs a transcode::stream.

Template Parameters
StreamArgTypeThe type of the first argument of StreamType's constructor.
Parameters
charsetThe name of the character encoding to convert from/to.
stream_argThe argument to pass as the first argument to StreamType's constructor.
modeThe open-mode to pass to StreamType's constructor.
Exceptions
std::invalid_argumentif charset is not supported.

Definition at line 317 of file transcode_stream.h.


The documentation for this class was generated from the following file:
blog comments powered by Disqus