FileReadStream Class Reference

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

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

Private Member Functions
void	Read ()

Private Attributes
std::FILE *	fp_
Ch *	buffer_
size_t	bufferSize_
Ch *	bufferLast_
Ch *	current_
size_t	readCount_
size_t	count_
	Number of characters read.
bool	eof_

Detailed Description

File byte stream for input using fread().

Note

implements Stream concept

Member Typedef Documentation

typedef char FileReadStream::Ch

Character type (byte).

Constructor & Destructor Documentation

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.

References fp_, RAPIDJSON_ASSERT, and Read().

Member Function Documentation

Ch FileReadStream::Peek ( ) const

inline

References current_.

Ch FileReadStream::Take ( )

inline

References current_, and Read().

size_t FileReadStream::Tell ( ) const

inline

References buffer_, count_, and current_.

void FileReadStream::Put ( Ch  )

inline

References RAPIDJSON_ASSERT.

void FileReadStream::Flush ( )

inline

References RAPIDJSON_ASSERT.

Ch* FileReadStream::PutBegin ( )

inline

References RAPIDJSON_ASSERT.

size_t FileReadStream::PutEnd ( Ch *  )

inline

References RAPIDJSON_ASSERT.

const Ch* FileReadStream::Peek4 ( ) const

inline

References bufferLast_, and current_.

void FileReadStream::Read ( )

inlineprivate

References buffer_, bufferLast_, bufferSize_, count_, current_, eof_, fp_, and readCount_.

Referenced by FileReadStream(), and Take().

Member Data Documentation

std::FILE* FileReadStream::fp_

private

Referenced by FileReadStream(), and Read().

Ch* FileReadStream::buffer_

private

Referenced by Read(), and Tell().

size_t FileReadStream::bufferSize_

private

Referenced by Read().

Ch* FileReadStream::bufferLast_

private

Referenced by Peek4(), and Read().

Ch* FileReadStream::current_

private

Referenced by Peek(), Peek4(), Read(), Take(), and Tell().

size_t FileReadStream::readCount_

private

Referenced by Read().

size_t FileReadStream::count_

private

Number of characters read.

Referenced by Read(), and Tell().

bool FileReadStream::eof_

private

Referenced by Read().

---

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

• filereadstream.h