BusBoy  2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
BUSBOY::RandomAccessFile Class Referenceabstract

File that allows arbitrary movement of the file pointer. More...

#include <RandomAccessFile.h>

Inheritance diagram for BUSBOY::RandomAccessFile:
BUSBOY::ExternalRandomAccessFile BUSBOY::WritableRandomAccessFile BUSBOY::ExternalRandomAccessFileSinkImpl BUSBOY::ExternalRandomAccessFileSinkImpl

Public Member Functions

virtual size_t read (char *buf, size_t num)=0
 Read up to the next num bytes into buf, returns the number of bytes read. More...
 
virtual size_t getLocation ()=0
 Returns the absolute location of the file pointer, in bytes. More...
 
virtual void setLocation (size_t loc)=0
 Set absolute location from file start. More...
 
virtual void setLocationFromEnd (size_t loc)=0
 Set location in bytes back from end of file. More...
 
virtual void skipForward (size_t num)=0
 Skip num bytes forward from current location. More...
 
virtual void skipBackward (size_t num)=0
 Skip num bytes backward from current location. More...
 
virtual size_t getFileSize ()=0
 
virtual void close ()=0
 
virtual bool isClosed () const =0
 

Detailed Description

File that allows arbitrary movement of the file pointer.

Implementations will most likely be local disk files

Member Function Documentation

virtual void BUSBOY::RandomAccessFile::close ( )
pure virtual
virtual size_t BUSBOY::RandomAccessFile::getFileSize ( )
pure virtual
virtual size_t BUSBOY::RandomAccessFile::getLocation ( )
pure virtual

Returns the absolute location of the file pointer, in bytes.

Implemented in BUSBOY::ExternalRandomAccessFile.

virtual bool BUSBOY::RandomAccessFile::isClosed ( ) const
pure virtual
virtual size_t BUSBOY::RandomAccessFile::read ( char *  buf,
size_t  num 
)
pure virtual

Read up to the next num bytes into buf, returns the number of bytes read.

Implemented in BUSBOY::ExternalRandomAccessFile.

virtual void BUSBOY::RandomAccessFile::setLocation ( size_t  loc)
pure virtual

Set absolute location from file start.

Implemented in BUSBOY::ExternalRandomAccessFile.

virtual void BUSBOY::RandomAccessFile::setLocationFromEnd ( size_t  loc)
pure virtual

Set location in bytes back from end of file.

Implemented in BUSBOY::ExternalRandomAccessFile.

virtual void BUSBOY::RandomAccessFile::skipBackward ( size_t  num)
pure virtual

Skip num bytes backward from current location.

Implemented in BUSBOY::ExternalRandomAccessFile.

virtual void BUSBOY::RandomAccessFile::skipForward ( size_t  num)
pure virtual

Skip num bytes forward from current location.

Implemented in BUSBOY::ExternalRandomAccessFile.


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

Copyright 2014 Google Inc. All rights reserved.