Unpacking.UnpackExtendedTypeObject Method (Stream)

UnpackingUnpackExtendedTypeObject Method (Stream)

Unpacks the MessagePackExtendedTypeObject which represents the extended type value. value from the specified Stream.

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

Syntax

public static MessagePackExtendedTypeObject UnpackExtendedTypeObject(
	Stream source
)

Public Shared Function UnpackExtendedTypeObject ( 
	source As Stream
) As MessagePackExtendedTypeObject

public:
static MessagePackExtendedTypeObject UnpackExtendedTypeObject(
	Stream^ source
)

static member UnpackExtendedTypeObject : 
        source : Stream -> MessagePackExtendedTypeObject

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

Type: MessagePackExtendedTypeObject
The unpacked the MessagePackExtendedTypeObject which represents the extended type value. 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 MessagePackExtendedTypeObject. Note that the state of source will be unpredictable espicially it is not seekable.
MessageNotSupportedException	The items count of the underlying collection body is over MaxValue.

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.