NullTreeScannerTKey, TValue Class

Represents a specialized implementation of SeekableTreeStream that acts as a null stream, providing no data and always returning false on reads.

Definition

Namespace: SnapDB.Snap
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
public class NullTreeScanner<TKey, TValue> : SeekableTreeStream<TKey, TValue>
where TKey : class, new()
where TValue : class, new()
Inheritance
Object    TreeStreamTKey, TValue    SeekableTreeStreamTKey, TValue    NullTreeScannerTKey, TValue

Type Parameters

TKey
The type of keys in the stream (must be a reference type).
TValue
The type of values in the stream (must be a reference type).

Constructors

NullTreeScannerTKey, TValue Initializes a new instance of the NullTreeScannerTKey, TValue class.

Properties

Eos Boolean indicating that the end of the stream has been read or class has been disposed.
(Inherited from TreeStreamTKey, TValue)
Instance Gets a static instance of the NullTreeScannerTKey, TValue class for convenience.
IsAlwaysSequential Gets if the stream is always in sequential order. Do not return true unless it is guaranteed that the data read from this stream is sequential.
(Inherited from TreeStreamTKey, TValue)
NeverContainsDuplicates Gets if the stream will never return duplicate keys. Do not return true unless it is guaranteed that the data read from this stream will never contain duplicates.
(Inherited from TreeStreamTKey, TValue)

Methods

Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from TreeStreamTKey, TValue)
Dispose(Boolean) Releases the unmanaged resources used by the TreeStreamTKey, TValue object and optionally releases the managed resources.
(Inherited from TreeStreamTKey, TValue)
EndOfStreamReached Occurs when the end of the stream has been reached. The default behavior is to call Dispose.
(Inherited from TreeStreamTKey, TValue)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Read Advances the stream to the next value. If before the beginning of the stream, advances to the first value
(Inherited from TreeStreamTKey, TValue)
ReadAsync Advances the stream to the next value. If before the beginning of the stream, advances to the first value
(Inherited from TreeStreamTKey, TValue)
ReadNext Reads the next key-value pair (always returns false since this is a null stream).
(Overrides TreeStreamTKey, TValueReadNext(TKey, TValue))
SeekToKey Seeks to the specified key (not implemented, as this is a null stream).
(Overrides SeekableTreeStreamTKey, TValueSeekToKey(TKey))
SetEos Sets the end-of-stream (EOS) flag, indicating whether the stream has reached its end.
(Inherited from TreeStreamTKey, TValue)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also