Cafu Engine
cf::FileSys::InFileI Class Referenceabstract
Inheritance diagram for cf::FileSys::InFileI:

Public Member Functions

virtual uint32_t Read (char *Buffer, uint32_t Size)=0
 Reads Size bytes into the Buffer. More...
 
virtual uint64_t GetSize () const =0
 Returns the size of the file. More...
 
- Public Member Functions inherited from cf::FileSys::FileI
virtual ~FileI ()
 The virtual destructor, so that derived classes can safely be deleted via a FileI (base class) pointer. More...
 
virtual bool IsOpen () const =0
 Returns whether the file has successfully been opened and is still open. More...
 
virtual const std::string & GetBaseName () const =0
 Returns the base name of this file. The base name is relative to and agnostic of the file system this file is in. More...
 
virtual const std::string & GetFullName () const =0
 Returns the full name of this file. More...
 
virtual uint64_t GetPos () const =0
 Returns the current read/write position in the file. More...
 
virtual bool Seek (int32_t Offset, SeekFromT SeekFrom)=0
 Modifies the position of the read/write pointer in the file. More...
 

Additional Inherited Members

- Public Types inherited from cf::FileSys::FileI
enum  SeekFromT { FROM_BEGINNING, FROM_CURRENT_POS, FROM_END }
 The values of this enumeration define from where the seek operation applies the offset. More...
 

Member Function Documentation

virtual uint64_t cf::FileSys::InFileI::GetSize ( ) const
pure virtual

Returns the size of the file.

Implemented in cf::FileSys::MemoryInFileT, and cf::FileSys::LocalInFileT.

virtual uint32_t cf::FileSys::InFileI::Read ( char *  Buffer,
uint32_t  Size 
)
pure virtual

Reads Size bytes into the Buffer.

Returns
How many bytes have actually been read.

Implemented in cf::FileSys::MemoryInFileT, and cf::FileSys::LocalInFileT.


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