DictionaryMessagePackSerializerBase(TDictionary, TKey, TValue) Class

DictionaryMessagePackSerializerBaseTDictionary, TKey, TValue Class

Provides common features for generic dictionary serializers.

Inheritance Hierarchy

SystemObject
  MsgPack.SerializationMessagePackSerializerTDictionary
    MsgPack.Serialization.CollectionSerializersDictionaryMessagePackSerializerBaseTDictionary, TKey, TValue
      MsgPack.Serialization.CollectionSerializersDictionaryMessagePackSerializerTDictionary, TKey, TValue

Namespace: MsgPack.Serialization.CollectionSerializers
Assembly: MsgPack (in MsgPack.dll) Version: 0.6.0

Syntax

C++

Copy

public abstract class DictionaryMessagePackSerializerBase<TDictionary, TKey, TValue> : MessagePackSerializer<TDictionary>, 
	ICollectionInstanceFactory
where TDictionary : Object, IEnumerable<KeyValuePair<TKey, TValue>>

Public MustInherit Class DictionaryMessagePackSerializerBase(Of TDictionary As {Object, IEnumerable(Of KeyValuePair(Of TKey, TValue))}, TKey, TValue)
	Inherits MessagePackSerializer(Of TDictionary)
	Implements ICollectionInstanceFactory

generic<typename TDictionary, typename TKey, typename TValue>
where TDictionary : Object, IEnumerable<KeyValuePair<TKey, TValue>>
public ref class DictionaryMessagePackSerializerBase abstract : public MessagePackSerializer<TDictionary>, 
	ICollectionInstanceFactory

[<AbstractClassAttribute>]
type DictionaryMessagePackSerializerBase<'TDictionary, 'TKey, 'TValue when 'TDictionary : Object and IEnumerable<KeyValuePair<'TKey, 'TValue>>> =  
    class
        inherit MessagePackSerializer<'TDictionary>
        interface ICollectionInstanceFactory
    end

Type Parameters

TDictionary: The type of the dictionary.
TKey: The type of the key of dictionary.
TValue: The type of the value of dictionary.

The DictionaryMessagePackSerializerBaseTDictionary, TKey, TValue type exposes the following members.

Constructors

	Name	Description
	DictionaryMessagePackSerializerBaseTDictionary, TKey, TValue	Initializes a new instance of the DictionaryMessagePackSerializerBaseTDictionary, TKey, TValue class.

Top

Properties

	Name	Description
	OwnerContext	Gets a SerializationContext which owns this serializer. (Inherited from MessagePackSerializerT.)
	PackerCompatibilityOptions	Gets the packer compatibility options for this instance. (Inherited from MessagePackSerializerT.)

Top

Methods

	Name	Description
	AddItem	When implemented by derive class, adds the deserialized item to the collection on TDictionary specific manner to implement UnpackToCore(Unpacker, TDictionary).
	CreateInstance	Creates a new collection instance with specified initial capacity.
	GetCount	When overridden in derived class, returns count of the dictionary.
	Pack	Serializes specified object to the Stream. (Inherited from MessagePackSerializerT.)
	PackSingleObject	Serializes specified object to the array of Byte. (Inherited from MessagePackSerializerT.)
	PackTo	Serializes specified object with specified Packer. (Inherited from MessagePackSerializerT.)
	PackToCore	Serializes specified object with specified Packer. (Overrides MessagePackSerializerTPackToCore(Packer, T).)
	Unpack	Deserialize object from the Stream. (Inherited from MessagePackSerializerT.)
	UnpackFrom	Deserializes object with specified Unpacker. (Inherited from MessagePackSerializerT.)
	UnpackFromCore	Deserializes object with specified Unpacker. (Overrides MessagePackSerializerTUnpackFromCore(Unpacker).)
	UnpackNil	Unpacks the nil value. (Inherited from MessagePackSerializerT.)
	UnpackSingleObject	Deserializes a single object from the array of Byte which contains a serialized object. (Inherited from MessagePackSerializerT.)
	UnpackTo	Deserializes collection items with specified Unpacker and stores them to collection. (Inherited from MessagePackSerializerT.)
	UnpackToCore	Deserializes collection items with specified Unpacker and stores them to collection. (Overrides MessagePackSerializerTUnpackToCore(Unpacker, T).)

Top

Remarks

This class provides framework to implement variable collection serializer, and this type seals some virtual members to maximize future backward compatibility. If you cannot use this class, you can implement your own serializer which inherits MessagePackSerializerT and implements ICollectionInstanceFactory.

Reference

MsgPack.Serialization.CollectionSerializers Namespace