Click or drag to resize

BinaryRecordReaderT Class

A record reader that reads from a stream created with a BinaryRecordWriterT.
Inheritance Hierarchy
SystemObject
  Ookii.Jumbo.IORecordReaderT
    Ookii.Jumbo.IOStreamRecordReaderT
      Ookii.Jumbo.IOBinaryRecordReaderT

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 0.3.0+dc1307f20e065bb638e0b73a34cd216f57e486f1
Syntax
public class BinaryRecordReader<T> : StreamRecordReader<T>

Type Parameters

T
The type of the record. Must implement IWritable or have an associated IValueWriterT implementation.

The BinaryRecordReaderT type exposes the following members.

Constructors
 NameDescription
Public methodBinaryRecordReaderT(Stream) Initializes a new instance of the BinaryRecordReaderT class that doesn't reuse records.
Public methodBinaryRecordReaderT(Stream, Boolean) Initializes a new instance of the BinaryRecordReaderT class.
Public methodBinaryRecordReaderT(Stream, Int64, Int64, Boolean) Initializes a new instance of the BinaryRecordReaderT class.
Public methodBinaryRecordReaderT(Stream, Int64, Int64, Boolean, Boolean) Initializes a new instance of the BinaryRecordReaderT class.
Public methodBinaryRecordReaderT(String, Boolean, Boolean, Int32, CompressionType, Int64) Initializes a new instance of the BinaryRecordReaderT class that reads from the specified file.
Top
Properties
 NameDescription
Public propertyBytesRead Gets the size of the records before deserialization.
(Inherited from StreamRecordReaderT)
Public propertyCurrentRecord Gets the current record.
(Inherited from RecordReaderT)
Protected propertyFirstRecordOffset Gets or sets the offset of the first record.
(Inherited from StreamRecordReaderT)
Public propertyHasFinished Gets a value indicating whether this instance has read all records.
(Inherited from RecordReaderT)
Public propertyHasRecords Gets a value that indicates whether there are records available on the data source that this reader is reading from.
(Inherited from RecordReaderT)
Public propertyInputBytes Gets the size of the records before deserialization.
(Inherited from StreamRecordReaderT)
Protected propertyOffset Gets the position in the stream where reading began.
(Inherited from StreamRecordReaderT)
Public propertyProgress Gets the progress of the reader.
(Inherited from StreamRecordReaderT)
Public propertyReadTime Gets the time spent reading.
(Inherited from RecordReaderT)
Protected propertyRecordInputStream Gets or sets the IRecordInputStream implementation of Stream.
(Inherited from StreamRecordReaderT)
Public propertyRecordsRead Gets the number of records that has been read by this record reader.
(Inherited from RecordReaderT)
Protected propertySize Gets the total size to read from the stream.
(Inherited from StreamRecordReaderT)
Public propertySourceName Gets or sets the an informational string indicating the source of the records.
(Inherited from RecordReaderT)
Protected propertyStream Gets the underlying stream from which this record reader is reading.
(Inherited from StreamRecordReaderT)
Top
Methods
 NameDescription
Protected methodCheckDisposed Checks if the object is disposed, and if so throws a ObjectDisposedException.
(Inherited from StreamRecordReaderT)
Public methodDispose Cleans up all resources held by this StreamRecordReader{T}.
(Inherited from RecordReaderT)
Protected methodDispose(Boolean) Cleans up all resources associated with this StreamRecordReaderT.
(Overrides StreamRecordReaderTDispose(Boolean))
Public methodEnumerateRecords Enumerates over all the records.
(Inherited from RecordReaderT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnHasRecordsChanged Raises the HasRecordsChanged event.
(Inherited from RecordReaderT)
Public methodReadRecord Reads a record.
(Inherited from RecordReaderT)
Protected methodReadRecordInternal Reads a record.
(Overrides RecordReaderTReadRecordInternal)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventHasRecordsChanged Occurs when the value of the HasRecords property changes.
(Inherited from RecordReaderT)
Top
Remarks

No attempt is made to verify that the stream contains the correct type of record. The stream must contain records of type T. They may not be of a type derived from T.

This class cannot be used to read starting from any offset other than zero or a structural boundary in a record aware stream with the DoNotCrossBoundary option set, because a file created with BinaryRecordWriterT does not contain any record boundaries that can be used to sync the file when starting at a random offset.

See Also