BasicIStreamWrapper< StreamType > Class Template Reference

BasicIStreamWrapper&lt; StreamType &gt; Class Template Reference#

Composable Kernel: BasicIStreamWrapper< StreamType > Class Template Reference
Public Types | Public Member Functions | List of all members
BasicIStreamWrapper< StreamType > Class Template Reference

Wrapper of std::basic_istream into RapidJSON's Stream concept. More...

#include <istreamwrapper.h>

Public Types

typedef StreamType::char_type Ch
 

Public Member Functions

 BasicIStreamWrapper (StreamType &stream)
 Constructor. More...
 
 BasicIStreamWrapper (StreamType &stream, char *buffer, size_t bufferSize)
 Constructor. More...
 
Ch Peek () const
 
Ch Take ()
 
size_t Tell () const
 
void Put (Ch)
 
void Flush ()
 
Ch * PutBegin ()
 
size_t PutEnd (Ch *)
 
const Ch * Peek4 () const
 

Detailed Description

template<typename StreamType>
class BasicIStreamWrapper< StreamType >

Wrapper of std::basic_istream into RapidJSON's Stream concept.

The classes can be wrapped including but not limited to:

  • std::istringstream
  • std::stringstream
  • std::wistringstream
  • std::wstringstream
  • std::ifstream
  • std::fstream
  • std::wifstream
  • std::wfstream
Template Parameters
StreamTypeClass derived from std::basic_istream.

Member Typedef Documentation

◆ Ch

template<typename StreamType >
typedef StreamType::char_type BasicIStreamWrapper< StreamType >::Ch

Constructor & Destructor Documentation

◆ BasicIStreamWrapper() [1/2]

template<typename StreamType >
BasicIStreamWrapper< StreamType >::BasicIStreamWrapper ( StreamType &  stream)
inline

Constructor.

Parameters
streamstream opened for read.

◆ BasicIStreamWrapper() [2/2]

template<typename StreamType >
BasicIStreamWrapper< StreamType >::BasicIStreamWrapper ( StreamType &  stream,
char *  buffer,
size_t  bufferSize 
)
inline

Constructor.

Parameters
streamstream opened for read.
bufferuser-supplied buffer.
bufferSizesize of buffer in bytes. Must >=4 bytes.

Member Function Documentation

◆ Flush()

template<typename StreamType >
void BasicIStreamWrapper< StreamType >::Flush ( )
inline

◆ Peek()

template<typename StreamType >
Ch BasicIStreamWrapper< StreamType >::Peek ( ) const
inline

◆ Peek4()

template<typename StreamType >
const Ch* BasicIStreamWrapper< StreamType >::Peek4 ( ) const
inline

◆ Put()

template<typename StreamType >
void BasicIStreamWrapper< StreamType >::Put ( Ch  )
inline

◆ PutBegin()

template<typename StreamType >
Ch* BasicIStreamWrapper< StreamType >::PutBegin ( )
inline

◆ PutEnd()

template<typename StreamType >
size_t BasicIStreamWrapper< StreamType >::PutEnd ( Ch *  )
inline

◆ Take()

template<typename StreamType >
Ch BasicIStreamWrapper< StreamType >::Take ( )
inline

◆ Tell()

template<typename StreamType >
size_t BasicIStreamWrapper< StreamType >::Tell ( ) const
inline
The documentation for this class was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/develop/include/rapidjson/istreamwrapper.h