Click or drag to resize
UnpackingUnpackObject Method (Stream)
Unpacks the MessagePackObject which represents the value which has MessagePack type semantics. value from the specified Stream.

Namespace: MsgPack
Assembly: MsgPack (in MsgPack.dll) Version: 0.6.0
Syntax
public static MessagePackObject UnpackObject(
	Stream source
)

Parameters

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

Return Value

Type: MessagePackObject
The unpacked the MessagePackObject which represents the value which has MessagePack type semantics. value.
Exceptions
ExceptionCondition
ArgumentNullExceptionsource is null.
ArgumentException The CanRead of source is false.
UnpackExceptionsource 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 MessagePackObject. 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.

See Also