Unpacking.UnpackByte Method (Stream)

UnpackingUnpackByte Method (Stream)

Unpacks Byte value from the specified Stream.

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

Syntax

public static byte UnpackByte(
	Stream source
)

Public Shared Function UnpackByte ( 
	source As Stream
) As Byte

public:
static unsigned char UnpackByte(
	Stream^ source
)

static member UnpackByte : 
        source : Stream -> byte

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

Type: Byte
The unpacked Byte 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 Byte. 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.