 | StreamRecordReaderT Class |
Inheritance HierarchyOokii.Jumbo.IORecordReaderT
Ookii.Jumbo.IOStreamRecordReaderT
Ookii.Jumbo.IOBinaryRecordReaderT
Ookii.Jumbo.IOLineRecordReader
Ookii.Jumbo.IORecordFileReaderT
Ookii.Jumbo.Jet.Samples.IOGenSortRecordReader
Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 2.0.0
SyntaxType Parameters
- T
- The type of the records to read.
The StreamRecordReaderT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StreamRecordReaderT(Stream) |
Initializes a new instance of the StreamRecordReaderT class with the specified stream.
|
| StreamRecordReaderT(Stream, Int64, Int64) |
Initializes a new instance of the StreamRecordReaderT class with the specified stream.
|
| StreamRecordReaderT(Stream, Int64, Int64, Boolean) |
Initializes a new instance of the StreamRecordReaderT class with the specified stream.
|
Properties| Name | Description | |
|---|---|---|
 | BytesRead |
Gets the size of the records before deserialization.
(Overrides RecordReaderTBytesRead.) |
| CurrentRecord |
Gets the current record.
(Inherited from RecordReaderT.) |
 | FirstRecordOffset |
Gets or sets the offset of the first record.
|
| 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.) |
| InputBytes |
Gets the size of the records before deserialization.
(Overrides RecordReaderTInputBytes.) |
| Offset |
Gets the position in the stream where reading began.
|
| Progress |
Gets the progress of the reader.
(Overrides RecordReaderTProgress.) |
| ReadTime |
Gets the time spent reading.
(Inherited from RecordReaderT.) |
| RecordInputStream |
Gets or sets the IRecordInputStream implementation of Stream.
|
| 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.
|
| 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.
|
Methods| Name | Description | |
|---|---|---|
| CheckDisposed |
Checks if the object is disposed, and if so throws a ObjectDisposedException.
|
 | Dispose |
Cleans up all resources held by this StreamRecordReader{T}.
(Inherited from RecordReaderT.) |
| Dispose(Boolean) |
Cleans up all resources associated with this StreamRecordReaderT.
(Overrides RecordReaderTDispose(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.
(Inherited from RecordReaderT.) |
| 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.) |
RemarksDeriving classes should start reading at Offset. If Offset is not on a record boundary, they should seek ahead to the first record boundary and start from there.
Deriving classes should use Offset and Size to determine when to stop returning records. If Offset + Size is not on a record boundary, they should continue reading until the next record boundary.
If the stream implements IRecordInputStream with DoNotCrossBoundary set, and Offset + Size is on a structural boundary, StopReadingAtPosition will be set to Offset + Size. In this situation, Read(Byte, Int32, Int32) may return 0 before Size bytes are read. A deriving class should check this and stop reading at that point.
See Also