PairEncodingBaseTKey, TValue Class

Represents an encoding method that takes both a key and a value to encode.

Definition

Namespace: SnapDB.Snap.Encoding
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
public abstract class PairEncodingBase<TKey, TValue>
Inheritance
Object    PairEncodingBaseTKey, TValue

Type Parameters

TKey
The key type.
TValue
The value type.

Constructors

PairEncodingBaseTKey, TValueInitializes a new instance of the PairEncodingBaseTKey, TValue class

Properties

ContainsEndOfStreamSymbol Gets if the stream supports a symbol that represents that the end of the stream has been encountered.
EncodingMethod Gets the encoding method that this class implements.
EndOfStreamSymbol The byte code to use as the end of stream symbol. May throw NotSupportedException if ContainsEndOfStreamSymbol is false.
MaxCompressionSize Gets the maximum amount of space that is required for the compression algorithm. This prevents lower levels from having overflows on the underlying streams. It is critical that this value be correct. Error on the side of too large of a value as a value too small will corrupt data and be next to impossible to track down the point of corruption
UsesPreviousKey Gets if the previous key will need to be presented to the encoding algorithms to property encode the next sample. Returning false will cause nulls to be passed in a parameters to the encoding.
UsesPreviousValue Gets if the previous value will need to be presented to the encoding algorithms to property encode the next sample. Returning false will cause nulls to be passed in a parameters to the encoding.

Methods

Clone Clones this encoding method.
Decode(BinaryStreamBase, TKey, TValue, TKey, TValue, Boolean) Decodes data from a binary stream, producing key-value pairs and indicating whether it's the end of the stream.
Decode(Byte*, TKey, TValue, TKey, TValue, Boolean) Decodes data from a byte pointer, producing key-value pairs and indicating whether it's the end of the stream.
Encode(BinaryStreamBase, TKey, TValue, TKey, TValue) Encodes key-value pairs and writes them to a binary stream.
Encode(Byte*, TKey, TValue, TKey, TValue) Encodes key-value pairs and writes them to a byte pointer.
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)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also