Unpacking.UnpackDictionaryCount Method (Stream)

UnpackingUnpackDictionaryCount Method (Stream)

Unpacks count of the dictionary entries value from the specified Stream.

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

Syntax

public static Nullable<long> UnpackDictionaryCount(
	Stream source
)

Public Shared Function UnpackDictionaryCount ( 
	source As Stream
) As Nullable(Of Long)

public:
static Nullable<long long> UnpackDictionaryCount(
	Stream^ source
)

static member UnpackDictionaryCount : 
        source : Stream -> Nullable<int64>

source: Type: System.IOStream
The Stream which contains Message Pack binary stream.

Type: NullableInt64
The unpacked count of the dictionary entries value.

Exceptions

Exception	Condition
ArgumentNullException	source is null.
ArgumentException	The CanRead of source is false.
UnpackException	source is not valid MessagePack stream. Note that the state of source will be unpredictable espicially it is not seekable.
MessageTypeException	The unpacked result in the source is not compatible to nullable Int64. Note that the state of source will be unpredictable espicially it is not seekable.

Remarks

The processed bytes count can be calculated via Position of source when the CanSeek is true.

When the type of packed value is not known, use UnpackObject(Stream) instead.