RecordFileReaderT Class

A record reader that reads files in the record file format.

Inheritance Hierarchy

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 0.3.0+dc1307f20e065bb638e0b73a34cd216f57e486f1

Syntax

public class RecordFileReader<T> : StreamRecordReader<T>

Public Class RecordFileReader(Of T)
	Inherits StreamRecordReader(Of T)

generic<typename T>
public ref class RecordFileReader : public StreamRecordReader<T>

type RecordFileReader<'T> = 
    class
        inherit StreamRecordReader<'T>
    end

The RecordFileReaderT type exposes the following members.

Constructors

	Name	Description
	RecordFileReaderT(Stream)	Initializes a new instance of the RecordFileReaderT class that reads from the specified stream.
	RecordFileReaderT(Stream, Int64, Int64, Boolean)	Initializes a new instance of the RecordFileReaderT class that reads the specified range of the specified stream, optionally reusing record instances.

Properties

	Name	Description
	BytesRead	Gets the size of the records before deserialization. (Inherited from StreamRecordReaderT)
	CurrentRecord	Gets the current record. (Inherited from RecordReaderT)
	FirstRecordOffset	Gets or sets the offset of the first record. (Inherited from StreamRecordReaderT)
	HasFinished	Gets a value indicating whether this instance has read all records. (Inherited from RecordReaderT)
	HasRecords	Gets a value that indicates whether there are records available on the data source that this reader is reading from. (Inherited from RecordReaderT)
	Header	Gets the header of that was read from the record file.
	InputBytes	Gets the size of the records before deserialization. (Inherited from StreamRecordReaderT)
	Offset	Gets the position in the stream where reading began. (Inherited from StreamRecordReaderT)
	Progress	Gets the progress of the reader. (Inherited from StreamRecordReaderT)
	ReadTime	Gets the time spent reading. (Inherited from RecordReaderT)
	RecordInputStream	Gets or sets the IRecordInputStream implementation of Stream. (Inherited from StreamRecordReaderT)
	RecordsRead	Gets the number of records that has been read by this record reader. (Inherited from RecordReaderT)
	Size	Gets the total size to read from the stream. (Inherited from StreamRecordReaderT)
	SourceName	Gets or sets the an informational string indicating the source of the records. (Inherited from RecordReaderT)
	Stream	Gets the underlying stream from which this record reader is reading. (Inherited from StreamRecordReaderT)

Methods

	Name	Description
	CheckDisposed	Checks if the object is disposed, and if so throws a ObjectDisposedException. (Inherited from StreamRecordReaderT)
	Dispose	Cleans up all resources held by this StreamRecordReader{T}. (Inherited from RecordReaderT)
	Dispose(Boolean)	Cleans up all resources associated with this RecordFileReaderT. (Overrides StreamRecordReaderTDispose(Boolean))
	EnumerateRecords	Enumerates over all the records. (Inherited from RecordReaderT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnHasRecordsChanged	Raises the HasRecordsChanged event. (Inherited from RecordReaderT)
	ReadRecord	Reads a record. (Inherited from RecordReaderT)
	ReadRecordInternal	Reads a record. (Overrides RecordReaderTReadRecordInternal)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	HasRecordsChanged	Occurs when the value of the HasRecords property changes. (Inherited from RecordReaderT)

Remarks

For more information about the format of record files, see RecordFileHeader.