Unpacking.UnpackByteStream Method

UnpackingUnpackByteStream Method

Unpacks raw value from the specified Stream as UnpackingStream.

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

Syntax

public static UnpackingStream UnpackByteStream(
	Stream source
)

Public Shared Function UnpackByteStream ( 
	source As Stream
) As UnpackingStream

public:
static UnpackingStream^ UnpackByteStream(
	Stream^ source
)

static member UnpackByteStream : 
        source : Stream -> UnpackingStream

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

Type: UnpackingStream
The UnpackingStream which represents raw value stream.

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 raw binary. Note that the state of source will be unpredictable espicially it is not seekable.

Remarks

UnpackingStream does not own source, so source still should be closed.

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