bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
BasicIStreamWrapper< StreamType > Class Template Reference

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

#include <istreamwrapper.h>

Inheritance diagram for BasicIStreamWrapper< StreamType >:
Inheritance graph
Collaboration diagram for BasicIStreamWrapper< StreamType >:
Collaboration graph

Public Types

typedef StreamType::char_type Ch
 

Public Member Functions

 BasicIStreamWrapper (StreamType &stream)
 Constructor.
 
 BasicIStreamWrapper (StreamType &stream, char *buffer, size_t bufferSize)
 Constructor.
 
void Flush ()
 
Ch Peek () const
 
const Ch * Peek4 () const
 
void Put (Ch)
 
Ch * PutBegin ()
 
size_t PutEnd (Ch *)
 
Ch Take ()
 
size_t Tell () 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.

Definition at line 49 of file istreamwrapper.h.

Member Typedef Documentation

◆ Ch

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

Definition at line 51 of file istreamwrapper.h.

Constructor & Destructor Documentation

◆ BasicIStreamWrapper() [1/2]

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

Constructor.

Parameters
streamstream opened for read.

Definition at line 57 of file istreamwrapper.h.

◆ 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.

Definition at line 67 of file istreamwrapper.h.

Member Function Documentation

◆ Flush()

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

Definition at line 78 of file istreamwrapper.h.

◆ Peek()

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

Definition at line 72 of file istreamwrapper.h.

◆ Peek4()

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

Definition at line 83 of file istreamwrapper.h.

◆ Put()

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

Definition at line 77 of file istreamwrapper.h.

◆ PutBegin()

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

Definition at line 79 of file istreamwrapper.h.

◆ PutEnd()

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

Definition at line 80 of file istreamwrapper.h.

◆ Take()

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

Definition at line 73 of file istreamwrapper.h.

◆ Tell()

template<typename StreamType>
size_t BasicIStreamWrapper< StreamType >::Tell ( ) const
inline

Definition at line 74 of file istreamwrapper.h.


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