FileReadStream Class Reference

Public Types | Public Member Functions | List of all members

FileReadStream Class Reference

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

#include <filereadstream.h>

Public Types
typedef char	Ch
	Character type (byte).

Public Member Functions
	FileReadStream (std::FILE *fp, char *buffer, size_t bufferSize)
	Constructor.
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

File byte stream for input using fread().

Note

implements Stream concept

Member Typedef Documentation

◆ Ch

typedef char FileReadStream::Ch

Character type (byte).

Constructor & Destructor Documentation

◆ FileReadStream()

FileReadStream::FileReadStream ( std::FILE * fp, char * buffer, size_t bufferSize )

inline

Constructor.

Parameters

fp	File pointer opened for read.
buffer	user-supplied buffer.
bufferSize	size of buffer in bytes. Must >=4 bytes.

Member Function Documentation

◆ Flush()

void FileReadStream::Flush ( )

inline

◆ Peek()

Ch FileReadStream::Peek ( ) const

inline

◆ Peek4()

const Ch * FileReadStream::Peek4 ( ) const

inline

◆ Put()

void FileReadStream::Put ( Ch )

inline

◆ PutBegin()

Ch * FileReadStream::PutBegin ( )

inline

◆ PutEnd()

size_t FileReadStream::PutEnd ( Ch * )

inline

◆ Take()

Ch FileReadStream::Take ( )

inline

◆ Tell()

size_t FileReadStream::Tell ( ) const

inline

---

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

• filereadstream.h