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

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

Public Member Functions
delegate DatumReader< T >	CreateDatumReader (Schema writerSchema, Schema readerSchema)

Header	GetHeader ()
	Return the header for the input file / stream More...

Schema	GetSchema ()
	Return the schema as read from the input file / stream More...

ICollection< string >	GetMetaKeys ()
	Return the list of keys in the metadata More...

byte []	GetMeta (string key)
	Return the byte value of a metadata property More...

long	GetMetaLong (string key)
	Return the long value of a metadata property More...

string	GetMetaString (string key)
	Return the string value of a metadata property More...

void	Seek (long position)
	Move to a specific, known synchronization point, one returned from IFileWriter.Sync() while writing More...

void	Sync (long position)
	Move to the next synchronization point after a position More...

bool	PastSync (long position)
	Return true if past the next synchronization point after a position More...

long	PreviousSync ()
	Return the last synchronization point before our current position More...

long	Tell ()
	Return the current position in the input More...

bool	HasNext ()
	True if more entries remain in this file. More...

void	Reset ()

void	Dispose ()

T	Next ()
	Read the next datum from the file. More...

Static Public Member Functions
static IFileReader< T >	OpenReader (string path)
	Open a reader for a file using path More...

static IFileReader< T >	OpenReader (string path, Schema readerSchema)
	Open a reader for a file using path and the reader's schema More...

static IFileReader< T >	OpenReader (Stream inStream)
	Open a reader for a stream More...

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema)
	Open a reader for a stream using the reader's schema More...

static IFileReader< T >	OpenReader (Stream inStream, Schema readerSchema, CreateDatumReader datumReaderFactory)
	Open a reader for a stream using the reader's schema and a custom DatumReader More...

Properties
IEnumerable< T >	NextEntries `[get]`

Properties inherited from Avro.File.IFileReader< T >
IEnumerable< T >	NextEntries `[get]`
	Return an enumeration of the remaining entries in the file More...

Detailed Description

Definition at line 28 of file DataFileReader.cs.

Member Function Documentation

◆ CreateDatumReader()

delegate DatumReader<T> Avro.File.DataFileReader< T >.CreateDatumReader	(	Schema	writerSchema,
		Schema	readerSchema
	)

◆ Dispose()

void Avro.File.DataFileReader< T >.Dispose ( )

inline

Definition at line 261 of file DataFileReader.cs.

◆ GetHeader()

Header Avro.File.DataFileReader< T >.GetHeader ( )

inline

Return the header for the input file / stream

Returns

Implements Avro.File.IFileReader< T >.

Definition at line 120 of file DataFileReader.cs.

◆ GetMeta()

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 >.

Definition at line 135 of file DataFileReader.cs.

◆ GetMetaKeys()

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

inline

Return the list of keys in the metadata

Returns

Implements Avro.File.IFileReader< T >.

Definition at line 130 of file DataFileReader.cs.

◆ GetMetaLong()

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 >.

Definition at line 147 of file DataFileReader.cs.

◆ GetMetaString()

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 >.

Definition at line 152 of file DataFileReader.cs.

◆ GetSchema()

Schema Avro.File.DataFileReader< T >.GetSchema ( )

inline

Return the schema as read from the input file / stream

Returns

Implements Avro.File.IFileReader< T >.

Definition at line 125 of file DataFileReader.cs.

◆ HasNext()

bool Avro.File.DataFileReader< T >.HasNext ( )

inline

True if more entries remain in this file.

Implements Avro.File.IFileReader< T >.

Definition at line 232 of file DataFileReader.cs.

◆ Next()

T Avro.File.DataFileReader< T >.Next ( )

inline

Read the next datum from the file.

Implements Avro.File.IFileReader< T >.

Definition at line 331 of file DataFileReader.cs.

◆ OpenReader() [1/5]

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader ( string path )

inlinestatic

Open a reader for a file using path

Parameters

path

Returns

Definition at line 51 of file DataFileReader.cs.

◆ OpenReader() [2/5]

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

inlinestatic

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

Parameters

path

Returns

Definition at line 61 of file DataFileReader.cs.

◆ OpenReader() [3/5]

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader ( Stream inStream )

inlinestatic

Open a reader for a stream

Parameters

inStream

Returns

Definition at line 71 of file DataFileReader.cs.

◆ OpenReader() [4/5]

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

inlinestatic

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

Parameters

inStream

Returns

Definition at line 81 of file DataFileReader.cs.

◆ OpenReader() [5/5]

static IFileReader<T> Avro.File.DataFileReader< T >.OpenReader	(	Stream	inStream,
		Schema	readerSchema,
		CreateDatumReader	datumReaderFactory
	)

inlinestatic

Open a reader for a stream using the reader's schema and a custom DatumReader

Parameters

inStream

Returns

Definition at line 92 of file DataFileReader.cs.

◆ PastSync()

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 >.

Definition at line 206 of file DataFileReader.cs.

◆ PreviousSync()

long Avro.File.DataFileReader< T >.PreviousSync ( )

inline

Return the last synchronization point before our current position

Returns

Implements Avro.File.IFileReader< T >.

Definition at line 211 of file DataFileReader.cs.

◆ Reset()

void Avro.File.DataFileReader< T >.Reset ( )

inline

Definition at line 256 of file DataFileReader.cs.

◆ Seek()

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 >.

Definition at line 169 of file DataFileReader.cs.

◆ Sync()

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 >.

Definition at line 178 of file DataFileReader.cs.

◆ Tell()

long Avro.File.DataFileReader< T >.Tell ( )

inline

Return the current position in the input

Returns

Implements Avro.File.IFileReader< T >.

Definition at line 216 of file DataFileReader.cs.

Property Documentation

◆ NextEntries

IEnumerable<T> Avro.File.DataFileReader< T >.NextEntries

get

Definition at line 222 of file DataFileReader.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Avro/src/apache/main/File/DataFileReader.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateDatumReader()

◆ Dispose()

◆ GetHeader()

◆ GetMeta()

◆ GetMetaKeys()

◆ GetMetaLong()

◆ GetMetaString()

◆ GetSchema()

◆ HasNext()

◆ Next()

◆ OpenReader() [1/5]

◆ OpenReader() [2/5]

◆ OpenReader() [3/5]

◆ OpenReader() [4/5]

◆ OpenReader() [5/5]

◆ PastSync()

◆ PreviousSync()

◆ Reset()

◆ Seek()

◆ Sync()

◆ Tell()

Property Documentation

◆ NextEntries