Avro.File.DataFileReader< T > Class Template Reference

Inheritance diagram for Avro.File.DataFileReader< T >:

List of all members.

Public Member Functions
Header	GetHeader ()
	Return the header for the input file / stream.
Schema	GetSchema ()
	Return the schema as read from the input file / stream.
ICollection< string >	GetMetaKeys ()
	Return the list of keys in the metadata.
byte[]	GetMeta (string key)
	Return the byte value of a metadata property.
long	GetMetaLong (string key)
	Return the long value of a metadata property.
string	GetMetaString (string key)
	Return the string value of a metadata property.
void	Seek (long position)
	Move to a specific, known synchronization point, one returned from IFileWriter.Sync() while writing.
void	Sync (long position)
	Move to the next synchronization point after a position.
bool	PastSync (long position)
	Return true if past the next synchronization point after a position.
long	PreviousSync ()
	Return the last synchronization point before our current position.
long	Tell ()
	Return the current position in the input.
bool	HasNext ()
	True if more entries remain in this file.
void	Reset ()
void	Dispose ()
T	Next ()
	Read the next datum from the file.
Static Public Member Functions
static IFileReader< T >	OpenReader (string path)
	Open a reader for a file using path.
static IFileReader< T >	OpenReader (string path, Schema readerSchema)
	Open a reader for a file using path and the reader's schema.
static IFileReader< T >	OpenReader (Stream inStream)
	Open a reader for a stream.
static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema)
	Open a reader for a stream and using the reader's schema.
Properties
IEnumerable< T >	NextEntries [get]
	Return an enumeration of the remaining entries in the file.

template<T>
class Avro::File::DataFileReader< T >

---

Member Function Documentation

template<T >

Header Avro.File.DataFileReader< T >.GetHeader

(

)

[inline]

Return the header for the input file / stream.

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

byte [] Avro.File.DataFileReader< T >.GetMeta

(

string

key

)

[inline]

Return the byte value of a metadata property.

Parameters:

key

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

ICollection<string> Avro.File.DataFileReader< T >.GetMetaKeys

(

)

[inline]

Return the list of keys in the metadata.

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

long Avro.File.DataFileReader< T >.GetMetaLong

(

string

key

)

[inline]

Return the long value of a metadata property.

Parameters:

key

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

string Avro.File.DataFileReader< T >.GetMetaString

(

string

key

)

[inline]

Return the string value of a metadata property.

Parameters:

key

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

Schema Avro.File.DataFileReader< T >.GetSchema

(

)

[inline]

Return the schema as read from the input file / stream.

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

bool Avro.File.DataFileReader< T >.HasNext

(

)

[inline]

True if more entries remain in this file.

Implements Avro.File.IFileReader< T >.

template<T >

T Avro.File.DataFileReader< T >.Next

(

)

[inline]

Read the next datum from the file.

Implements Avro.File.IFileReader< T >.

template<T >

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader

(

string

path

)

[inline, static]

Open a reader for a file using path.

Parameters:

path

Returns:

template<T >

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader	(	string	path,
		Schema	readerSchema
	)		[inline, static]

Open a reader for a file using path and the reader's schema.

Parameters:

path

Returns:

template<T >

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader

(

Stream

inStream

)

[inline, static]

Open a reader for a stream.

Parameters:

inStream

Returns:

template<T >

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema
	)		[inline, static]

Open a reader for a stream and using the reader's schema.

Parameters:

inStream

Returns:

template<T >

bool Avro.File.DataFileReader< T >.PastSync

(

long

position

)

[inline]

Return true if past the next synchronization point after a position.

Parameters:

position

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

long Avro.File.DataFileReader< T >.PreviousSync

(

)

[inline]

Return the last synchronization point before our current position.

Returns:

Implements Avro.File.IFileReader< T >.

template<T >

void Avro.File.DataFileReader< T >.Seek

(

long

position

)

[inline]

Move to a specific, known synchronization point, one returned from IFileWriter.Sync() while writing.

Parameters:

position

Implements Avro.File.IFileReader< T >.

template<T >

void Avro.File.DataFileReader< T >.Sync

(

long

position

)

[inline]

Move to the next synchronization point after a position.

Parameters:

position

Implements Avro.File.IFileReader< T >.

template<T >

long Avro.File.DataFileReader< T >.Tell

(

)

[inline]

Return the current position in the input.

Returns:

Implements Avro.File.IFileReader< T >.

---

Property Documentation

template<T >

IEnumerable<T> Avro.File.DataFileReader< T >.NextEntries [get]

Return an enumeration of the remaining entries in the file.

Returns:

Implements Avro.File.IFileReader< T >.

---

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

• src/apache/main/File/DataFileReader.cs