Avro C++
Public Member Functions
avro::DataFileReader< T > Class Template Reference

Reads the contents of data file one after another. More...

#include <DataFile.hh>

Inheritance diagram for avro::DataFileReader< T >:
noncopyable

List of all members.

Public Member Functions

 DataFileReader (const char *filename, const ValidSchema &readerSchema)
 Constructs the reader for the given file and the reader is expected to use the given schema.
 DataFileReader (const char *filename)
 Constructs the reader for the given file and the reader is expected to use the schema that is used with data.
 DataFileReader (std::auto_ptr< DataFileReaderBase > base)
 Constructs a reader using the reader base.
 DataFileReader (std::auto_ptr< DataFileReaderBase > base, const ValidSchema &readerSchema)
 Constructs a reader using the reader base.
bool read (T &datum)
 Reads the next entry from the data file.
const ValidSchemareaderSchema ()
 Returns the schema for this object.
const ValidSchemadataSchema ()
 Returns the schema stored with the data file.
void close ()
 Closes the reader.

Detailed Description

template<typename T>
class avro::DataFileReader< T >

Reads the contents of data file one after another.


Constructor & Destructor Documentation

template<typename T >
avro::DataFileReader< T >::DataFileReader ( std::auto_ptr< DataFileReaderBase base) [inline]

Constructs a reader using the reader base.

This form of constructor allows the user to examine the schema of a given file and then decide to use the right type of data to be desrialize. Without this the user must know the type of data for the template _before_ he knows the schema within the file. The schema present in the data file will be used for reading from this reader.

template<typename T >
avro::DataFileReader< T >::DataFileReader ( std::auto_ptr< DataFileReaderBase base,
const ValidSchema readerSchema 
) [inline]

Constructs a reader using the reader base.

This form of constructor allows the user to examine the schema of a given file and then decide to use the right type of data to be desrialize. Without this the user must know the type of data for the template _before_ he knows the schema within the file. The argument readerSchema will be used for reading from this reader.


Member Function Documentation

template<typename T >
void avro::DataFileReader< T >::close ( ) [inline]

Closes the reader.

No further operation is possible on this reader.

template<typename T >
bool avro::DataFileReader< T >::read ( T &  datum) [inline]

Reads the next entry from the data file.

Returns:
true if an object has been successfully read into datum and false if there are no more entries in the file.

References avro::decode().


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