Torque2D Reference
Public Types | Public Member Functions | List of all members
FileReadStream Class Reference

File byte stream for input using fread(). More...

#include <filereadstream.h>

+ Inheritance diagram for FileReadStream:

Public Types

typedef char Ch
 Character type (byte). More...
 

Public Member Functions

 FileReadStream (FILE *fp, char *buffer, size_t bufferSize)
 Constructor. More...
 
Ch Peek () const
 
Ch Take ()
 
size_t Tell () const
 
void Put (Ch)
 
void Flush ()
 
ChPutBegin ()
 
size_t PutEnd (Ch *)
 
const ChPeek4 () const
 

Detailed Description

File byte stream for input using fread().

Member Typedef Documentation

typedef char Ch

Character type (byte).

Constructor & Destructor Documentation

FileReadStream ( FILE *  fp,
char *  buffer,
size_t  bufferSize 
)
inline

Constructor.

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

Member Function Documentation

void Flush ( )
inline
Ch Peek ( ) const
inline
const Ch* Peek4 ( ) const
inline
void Put ( Ch  )
inline
Ch* PutBegin ( )
inline
size_t PutEnd ( Ch )
inline
Ch Take ( )
inline
size_t Tell ( ) const
inline

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