SortedTreeScannerBaseTKey, TValue Class

Base class for reading from any implementation of a sorted trees.

Definition

Namespace: SnapDB.Snap.Tree
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e

C#View Source Request Example

public abstract class SortedTreeScannerBase<TKey, TValue> : SeekableTreeStream<TKey, TValue>
where TKey : new(), SnapTypeBase<TKey>
where TValue : new(), SnapTypeBase<TValue>

VBView Source Request Example

Public MustInherit Class SortedTreeScannerBase(Of TKey As {New, SnapTypeBase(Of TKey)}, TValue As {New, SnapTypeBase(Of TValue)})
	Inherits SeekableTreeStream(Of TKey, TValue)

C++View Source Request Example

generic<typename TKey, typename TValue>
where TKey : gcnew(), SnapTypeBase<TKey>
where TValue : gcnew(), SnapTypeBase<TValue>
public ref class SortedTreeScannerBase abstract : public SeekableTreeStream<TKey, TValue>

JavaScriptView Source Request Example

JavaScript does not support generic types or methods.

Inheritance: Object TreeStreamTKey, TValue SeekableTreeStreamTKey, TValue SortedTreeScannerBaseTKey, TValue

Derived: SnapDB.Snap.TreeFixedSizeNodeScannerTKey, TValue
SnapDB.Snap.TreeGenericEncodedNodeScannerTKey, TValue

Type Parameters

TKey: The key type to use in the SortedTreeScannerBaseTKey, TValue.
TValue: The value type to use in the SortedTreeScannerBaseTKey, TValue.

Constructors

SortedTreeScannerBaseTKey, TValue

Initializes a new instance of the GenericEncodedNodeScannerTKey, TValue class.

Properties

Eos	Boolean indicating that the end of the stream has been read or class has been disposed. (Inherited from TreeStreamTKey, TValue)
HeaderSize	The number of bytes in the header of any given node.
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. (Overrides TreeStreamTKey, TValueIsAlwaysSequential)
LeftSiblingNodeIndex	The node index of the previous sibling. uint.MaxValue means there is no sibling to the right.
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. (Overrides TreeStreamTKey, TValueNeverContainsDuplicates)
NodeIndex	The index of the current node.
Pointer	The pointer that is right after the header of the node.
PointerVersion	The pointer version of the Pointer. Compare to Stream.PointerVersion to find out if this pointer is current.
RecordCount	The number of records in the current node.
RightSiblingNodeIndex	The node index of the next sibling. uint.MaxValue means there is no sibling to the right.

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)
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)
FindKey	Using Pointer advance to the search location of the provided key.
FindLeafNodeAddress	Gets the block index when seeking for the provided key.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
InternalPeek	Peeks at the next key and value in the node without advancing the cursor.
InternalRead(TKey, TValue)	Reads the next key and value from the node and advances the cursor.
InternalRead(TKey, TValue, MatchFilterBaseTKey, TValue)	Reads the next key and value from the node while applying a filter and advances the cursor.
InternalReadWhile(TKey, TValue, TKey)	Reads the next key and value from the node while the key is less than the upper bounds and advances the cursor.
InternalReadWhile(TKey, TValue, TKey, MatchFilterBaseTKey, TValue)	Reads the next key and value from the node while applying a filter and the key is less than the upper bounds, and advances the cursor.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnNoadReload	Occurs when a node's data is reset. Derived classes can override this method if fields need to be reset when a node is loaded.
Peek	Reads the next point, but doees not advance the position of the stream.
PeekCatchAll	Peeks at the next key and value in the node without advancing the cursor and handles various cases.
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)
ReadBackwardish	Reads the key-value pair backwardish (in reverse order) from the tree node.
ReadCatchAll	A catch all read function.
ReadNext	Advances the stream to the next value. If before the beginning of the stream, advances to the first value. (Overrides TreeStreamTKey, TValueReadNext(TKey, TValue))
ReadWhile(TKey, TValue, TKey)	Continues to advance the stream but stops short of returning the point that is equal to the provided key.
ReadWhile(TKey, TValue, TKey, MatchFilterBaseTKey, TValue)	Using the provided filter, continues to advance the stream but stops short of returning the point that is equal to the provided key.
ReadWhileCatchAll(TKey, TValue, TKey)	Reads key-value pairs in the node while the key is less than the upper bounds, handling various cases and advancing the cursor.
ReadWhileCatchAll(TKey, TValue, TKey, MatchFilterBaseTKey, TValue)	Reads key-value pairs in the node while the key is less than the upper bounds, applying an optional filter, and advancing the cursor.
SeekToKey	Seeks the stream to the first value greater than or equal to key. (Overrides SeekableTreeStreamTKey, TValueSeekToKey(TKey))
SeekToStart	Seeks to the start of SortedTree.
SetEos	Sets the end-of-stream (EOS) flag, indicating whether the stream has reached its end. (Inherited from TreeStreamTKey, TValue)
ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

BlockSize	Represents the size of the block within the node.
IndexOfNextKeyValue	The index number of the next key/value that needs to be read. The valid range of this field is [0, RecordCount - 1].
KeyMethods	Represents the custom methods for the keys used in this context.
KeySize	Represents the size, in bytes, of the keys used in this context.
LowerKey	Represents the lower bound key used in this context.
Stream	Represents the stream used in this context.
UpperKey	Represents the upper bound key used in this context.
ValueSize	Represents the size, in bytes, of the values used in this context.