engine::FileStreamI Class Reference

Inheritance diagram for engine::FileStreamI:

Public Member Functions
	FileStreamI (std::string filename)
std::string &	GetFilename ()
int64_t &	GetSize ()
virtual int64_t	Seek (int64_t offset, int whence)=0
virtual size_t	Read (void *ptr, size_t size, size_t maxnum)=0
virtual FILE *	GetFP ()=0
virtual std::string	ReadBufferString ()=0

Protected Attributes
std::string	m_filename
int64_t	m_size

Detailed Description

Provides an abstraction over file access.

Member Function Documentation

GetFP()

virtual FILE * engine::FileStreamI::GetFP ( )

pure virtual

Direct access to the file. Do not close by yourself.

Implemented in engine::FileMemoryBufferStreamFromFile.

GetSize()

int64_t & engine::FileStreamI::GetSize ( )

inline

Return the size of the file, or -1 if unknown

Read()

virtual size_t engine::FileStreamI::Read ( void *  ptr, size_t  size, size_t  maxnum  )

pure virtual

Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.

Returns

the number of objects read, or 0 at error or end of file.

Implemented in engine::FileMemoryBufferStreamFromFile.

ReadBufferString()

virtual std::string engine::FileStreamI::ReadBufferString ( )

pure virtual

Helper to read the whole file as string

Implemented in engine::FileMemoryBufferStreamFromFile.

Seek()

virtual int64_t engine::FileStreamI::Seek ( int64_t  offset, int  whence  )

pure virtual

Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END

Returns

the final offset in the data stream, or -1 on error.

Implemented in engine::FileMemoryBufferStreamFromFile.