Represents deserialized object of MsgPack. More...

Inherits IEquatable< MessagePackObject >.

Public Member Functions

 MessagePackObject (Boolean value)
 Initializes a new instance of the MessagePackObject type which wraps Boolean instance. More...
 
 MessagePackObject (Byte value)
 Initializes a new instance of the MessagePackObject type which wraps Byte instance. More...
 
 MessagePackObject (SByte value)
 Initializes a new instance of the MessagePackObject type which wraps SByte instance. More...
 
 MessagePackObject (Int16 value)
 Initializes a new instance of the MessagePackObject type which wraps Int16 instance. More...
 
 MessagePackObject (UInt16 value)
 Initializes a new instance of the MessagePackObject type which wraps UInt16 instance. More...
 
 MessagePackObject (Int32 value)
 Initializes a new instance of the MessagePackObject type which wraps Int32 instance. More...
 
 MessagePackObject (UInt32 value)
 Initializes a new instance of the MessagePackObject type which wraps UInt32 instance. More...
 
 MessagePackObject (Int64 value)
 Initializes a new instance of the MessagePackObject type which wraps Int64 instance. More...
 
 MessagePackObject (UInt64 value)
 Initializes a new instance of the MessagePackObject type which wraps UInt64 instance. More...
 
 MessagePackObject (Single value)
 Initializes a new instance of the MessagePackObject type which wraps Single instance. More...
 
 MessagePackObject (Double value)
 Initializes a new instance of the MessagePackObject type which wraps Double instance. More...
 
 MessagePackObject (String value)
 Initializes a new instance of the MessagePackObject type which wraps String instance. More...
 
 MessagePackObject (Byte[] value)
 Initializes a new instance of the Byte[] type which wraps Byte[] instance with specified manner. More...
 
 MessagePackObject (Byte[] value, bool isBinary)
 Initializes a new instance of the Byte[] type which wraps Byte[] instance with specified manner. More...
 
 MessagePackObject (MessagePackExtendedTypeObject value)
 Initializes a new instance of the MessagePackObject type which wraps MessagePackExtendedTypeObject instance. More...
 
Boolean AsBoolean ()
 Convert this instance to Boolean instance. More...
 
Byte AsByte ()
 Convert this instance to Byte instance. More...
 
SByte AsSByte ()
 Convert this instance to SByte instance. More...
 
Int16 AsInt16 ()
 Convert this instance to Int16 instance. More...
 
UInt16 AsUInt16 ()
 Convert this instance to UInt16 instance. More...
 
Int32 AsInt32 ()
 Convert this instance to Int32 instance. More...
 
UInt32 AsUInt32 ()
 Convert this instance to UInt32 instance. More...
 
Int64 AsInt64 ()
 Convert this instance to Int64 instance. More...
 
UInt64 AsUInt64 ()
 Convert this instance to UInt64 instance. More...
 
Single AsSingle ()
 Convert this instance to Single instance. More...
 
Double AsDouble ()
 Convert this instance to Double instance. More...
 
String AsString ()
 Convert this instance to String instance. More...
 
Byte[] AsBinary ()
 Convert this instance to Byte[] instance. More...
 
MessagePackExtendedTypeObject AsMessagePackExtendedTypeObject ()
 Convert this instance to MessagePackExtendedTypeObject instance. More...
 
 MessagePackObject (IList< MessagePackObject > value)
 Initializes a new instance wraps IList<MessagePackObject>. More...
 
 MessagePackObject (IList< MessagePackObject > value, bool isImmutable)
 Initializes a new instance wraps IList<MessagePackObject>. More...
 
 MessagePackObject (MessagePackObjectDictionary value)
 Initializes a new instance wraps MessagePackObjectDictionary. More...
 
 MessagePackObject (MessagePackObjectDictionary value, bool isImmutable)
 Initializes a new instance wraps MessagePackObjectDictionary. More...
 
override bool Equals (Object obj)
 Compare two instances are equal. More...
 
bool Equals (MessagePackObject other)
 Compare two instances are equal. More...
 
override int GetHashCode ()
 Get hash code of this instance. More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 
bool? IsTypeOf< T > ()
 Determine whether the underlying value of this instance is specified type or not. More...
 
bool? IsTypeOf (Type type)
 Determine whether the underlying value of this instance is specified type or not. More...
 
void PackToMessage (Packer packer, PackingOptions options)
 Packs this instance itself using specified Packer. More...
 
string AsString (Encoding encoding)
 Gets the underlying value as string encoded with specified Encoding. More...
 
string AsStringUtf8 ()
 Get underlying value as UTF8 string. More...
 
string AsStringUtf16 ()
 Get underlying value as UTF-16 string. More...
 
char[] AsCharArray ()
 Get underlying value as UTF-16 charcter array. More...
 
IEnumerable< MessagePackObjectAsEnumerable ()
 Get underlying value as IEnumerable<MessagePackObject>. More...
 
IList< MessagePackObjectAsList ()
 Get underlying value as IList<MessagePackObject>. More...
 
MessagePackObjectDictionary AsDictionary ()
 Get underlying value as MessagePackObjectDictionary. More...
 
object ToObject ()
 Get boxed underlying value for this object. More...
 
Timestamp AsTimestamp ()
 Gets a this object as a Timestamp value. More...
 

Static Public Member Functions

static implicit operator MessagePackObject (Boolean value)
 Convert Booleaninstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Byte value)
 Convert Byteinstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (SByte value)
 Convert SByteinstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Int16 value)
 Convert Int16instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (UInt16 value)
 Convert UInt16instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Int32 value)
 Convert Int32instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (UInt32 value)
 Convert UInt32instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Int64 value)
 Convert Int64instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (UInt64 value)
 Convert UInt64instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Single value)
 Convert Singleinstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Double value)
 Convert Doubleinstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (String value)
 Convert Stringinstance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (Byte[] value)
 Convert Byte[]instance to MessagePackObject instance. More...
 
static implicit operator MessagePackObject (MessagePackExtendedTypeObject value)
 Convert MessagePackExtendedTypeObjectinstance to MessagePackObject instance. More...
 
static operator Boolean (MessagePackObject value)
 Convert this instance to Boolean instance. More...
 
static operator Byte (MessagePackObject value)
 Convert this instance to Byte instance. More...
 
static operator SByte (MessagePackObject value)
 Convert this instance to SByte instance. More...
 
static operator Int16 (MessagePackObject value)
 Convert this instance to Int16 instance. More...
 
static operator UInt16 (MessagePackObject value)
 Convert this instance to UInt16 instance. More...
 
static operator Int32 (MessagePackObject value)
 Convert this instance to Int32 instance. More...
 
static operator UInt32 (MessagePackObject value)
 Convert this instance to UInt32 instance. More...
 
static operator Int64 (MessagePackObject value)
 Convert this instance to Int64 instance. More...
 
static operator UInt64 (MessagePackObject value)
 Convert this instance to UInt64 instance. More...
 
static operator Single (MessagePackObject value)
 Convert this instance to Single instance. More...
 
static operator Double (MessagePackObject value)
 Convert this instance to Double instance. More...
 
static operator String (MessagePackObject value)
 Convert this instance to String instance. More...
 
static operator Byte[] (MessagePackObject value)
 Convert this instance to Byte[] instance. More...
 
static operator MessagePackExtendedTypeObject (MessagePackObject value)
 Convert this instance to MessagePackExtendedTypeObject instance. More...
 
static MessagePackObject FromObject (object boxedValue)
 Wraps specified object as MessagePackObject recursively. More...
 
static bool operator== (MessagePackObject left, MessagePackObject right)
 Compare two instances are equal. More...
 
static bool operator!= (MessagePackObject left, MessagePackObject right)
 Compare two instances are not equal. More...
 
static implicit operator MessagePackObject (MessagePackObject[] value)
 Convert MessagePackObject[] instance to MessagePackObject instance. More...
 

Static Public Attributes

static readonly MessagePackObject Nil = default ( MessagePackObject )
 Instance represents nil. This is equal to default value. More...
 

Properties

bool IsNil [get]
 Get whether this instance represents nil. More...
 
bool IsRaw [get]
 Get the value indicates whether this instance wraps raw binary (or string) or not. More...
 
bool IsList [get]
 Get the value indicates whether this instance wraps list (array) or not. More...
 
bool IsArray [get]
 Get the value indicates whether this instance wraps list (array) or not. More...
 
bool IsDictionary [get]
 Get the value indicates whether this instance wraps dictionary (map) or not. More...
 
bool IsMap [get]
 Get the value indicates whether this instance wraps dictionary (map) or not. More...
 
Type UnderlyingType [get]
 Get underlying type of this instance. More...
 

Detailed Description

Represents deserialized object of MsgPack.

Constructor & Destructor Documentation

◆ MessagePackObject() [1/19]

MsgPack.MessagePackObject.MessagePackObject ( Boolean  value)

Initializes a new instance of the MessagePackObject type which wraps Boolean instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [2/19]

MsgPack.MessagePackObject.MessagePackObject ( Byte  value)

Initializes a new instance of the MessagePackObject type which wraps Byte instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [3/19]

MsgPack.MessagePackObject.MessagePackObject ( SByte  value)

Initializes a new instance of the MessagePackObject type which wraps SByte instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [4/19]

MsgPack.MessagePackObject.MessagePackObject ( Int16  value)

Initializes a new instance of the MessagePackObject type which wraps Int16 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [5/19]

MsgPack.MessagePackObject.MessagePackObject ( UInt16  value)

Initializes a new instance of the MessagePackObject type which wraps UInt16 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [6/19]

MsgPack.MessagePackObject.MessagePackObject ( Int32  value)

Initializes a new instance of the MessagePackObject type which wraps Int32 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [7/19]

MsgPack.MessagePackObject.MessagePackObject ( UInt32  value)

Initializes a new instance of the MessagePackObject type which wraps UInt32 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [8/19]

MsgPack.MessagePackObject.MessagePackObject ( Int64  value)

Initializes a new instance of the MessagePackObject type which wraps Int64 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [9/19]

MsgPack.MessagePackObject.MessagePackObject ( UInt64  value)

Initializes a new instance of the MessagePackObject type which wraps UInt64 instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [10/19]

MsgPack.MessagePackObject.MessagePackObject ( Single  value)

Initializes a new instance of the MessagePackObject type which wraps Single instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [11/19]

MsgPack.MessagePackObject.MessagePackObject ( Double  value)

Initializes a new instance of the MessagePackObject type which wraps Double instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [12/19]

MsgPack.MessagePackObject.MessagePackObject ( String  value)

Initializes a new instance of the MessagePackObject type which wraps String instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [13/19]

MsgPack.MessagePackObject.MessagePackObject ( Byte[]  value)

Initializes a new instance of the Byte[] type which wraps Byte[] instance with specified manner.

Parameters
valueA bytes array to be wrapped.

This constructor invokes MessagePackObject(Byte[],Boolean) with false, that means if you pass tha bytes array which is valid utf-8, resulting object can be String, and its UnderlyingType should be String.

◆ MessagePackObject() [14/19]

MsgPack.MessagePackObject.MessagePackObject ( Byte[]  value,
bool  isBinary 
)

Initializes a new instance of the Byte[] type which wraps Byte[] instance with specified manner.

Parameters
valueA bytes array to be wrapped.
isBinarytrue if value always should be binary; false, otherwise.

When the isBinary is true, then resulting object represents binary even if the value is valid utf-8 sequence, that is, its UnderlyingType should be Byte[]. On the other hand, when contrast, the isBinary is false, and if the value is valid utf-8, then the resulting object can be String, and its UnderlyingType should be String.

◆ MessagePackObject() [15/19]

MsgPack.MessagePackObject.MessagePackObject ( MessagePackExtendedTypeObject  value)

Initializes a new instance of the MessagePackObject type which wraps MessagePackExtendedTypeObject instance.

Parameters
valueA MessagePackObject value to be wrapped.

◆ MessagePackObject() [16/19]

MsgPack.MessagePackObject.MessagePackObject ( IList< MessagePackObject value)

Initializes a new instance wraps IList<MessagePackObject>.

Parameters
valueThe collection to be copied.

◆ MessagePackObject() [17/19]

MsgPack.MessagePackObject.MessagePackObject ( IList< MessagePackObject value,
bool  isImmutable 
)

Initializes a new instance wraps IList<MessagePackObject>.

Parameters
valueThe collection to be copied or used.
isImmutabletrue if the value is immutable collection; othereise, false.

When the collection is truely immutable or dedicated, you can specify true to the isImmutable . When isImmutable is true, this constructor does not copy its contents, or copies its contents otherwise. <note> Note that both of IReadOnlyList and System.Collections.ObjectModel.ReadOnlyCollection<T> is NOT immutable because the modification to the underlying collection will be reflected to the read-only collection. </note>

◆ MessagePackObject() [18/19]

MsgPack.MessagePackObject.MessagePackObject ( MessagePackObjectDictionary  value)

Initializes a new instance wraps MessagePackObjectDictionary.

Parameters
valueThe dictitonary to be copied.

◆ MessagePackObject() [19/19]

MsgPack.MessagePackObject.MessagePackObject ( MessagePackObjectDictionary  value,
bool  isImmutable 
)

Initializes a new instance wraps MessagePackObjectDictionary.

Parameters
valueThe dictitonary to be copied or used.
isImmutabletrue if the value is immutable collection; othereise, false.

When the collection is truely immutable or dedicated, you can specify true to the isImmutable . When isImmutable is true, this constructor does not copy its contents, or copies its contents otherwise. <note> Note that both of IReadOnlyDictionary and ReadOnlyDictionary is NOT immutable because the modification to the underlying collection will be reflected to the read-only collection. </note>

Member Function Documentation

◆ AsBinary()

Byte [] MsgPack.MessagePackObject.AsBinary ( )

Convert this instance to Byte[] instance.

Returns
Byte[] instance corresponds to this instance.

◆ AsBoolean()

Boolean MsgPack.MessagePackObject.AsBoolean ( )

Convert this instance to Boolean instance.

Returns
Boolean instance corresponds to this instance.

◆ AsByte()

Byte MsgPack.MessagePackObject.AsByte ( )

Convert this instance to Byte instance.

Returns
Byte instance corresponds to this instance.

◆ AsCharArray()

char [] MsgPack.MessagePackObject.AsCharArray ( )

Get underlying value as UTF-16 charcter array.

Returns
Underlying string.

◆ AsDictionary()

MessagePackObjectDictionary MsgPack.MessagePackObject.AsDictionary ( )

Get underlying value as MessagePackObjectDictionary.

Returns
Underlying MessagePackObjectDictionary.

◆ AsDouble()

Double MsgPack.MessagePackObject.AsDouble ( )

Convert this instance to Double instance.

Returns
Double instance corresponds to this instance.

◆ AsEnumerable()

IEnumerable<MessagePackObject> MsgPack.MessagePackObject.AsEnumerable ( )

Get underlying value as IEnumerable<MessagePackObject>.

Returns
Underlying IEnumerable<MessagePackObject>.

◆ AsInt16()

Int16 MsgPack.MessagePackObject.AsInt16 ( )

Convert this instance to Int16 instance.

Returns
Int16 instance corresponds to this instance.

◆ AsInt32()

Int32 MsgPack.MessagePackObject.AsInt32 ( )

Convert this instance to Int32 instance.

Returns
Int32 instance corresponds to this instance.

◆ AsInt64()

Int64 MsgPack.MessagePackObject.AsInt64 ( )

Convert this instance to Int64 instance.

Returns
Int64 instance corresponds to this instance.

◆ AsList()

IList<MessagePackObject> MsgPack.MessagePackObject.AsList ( )

Get underlying value as IList<MessagePackObject>.

Returns
Underlying IList<MessagePackObject>.

◆ AsMessagePackExtendedTypeObject()

MessagePackExtendedTypeObject MsgPack.MessagePackObject.AsMessagePackExtendedTypeObject ( )

Convert this instance to MessagePackExtendedTypeObject instance.

Returns
MessagePackExtendedTypeObject instance corresponds to this instance.

◆ AsSByte()

SByte MsgPack.MessagePackObject.AsSByte ( )

Convert this instance to SByte instance.

Returns
SByte instance corresponds to this instance.

◆ AsSingle()

Single MsgPack.MessagePackObject.AsSingle ( )

Convert this instance to Single instance.

Returns
Single instance corresponds to this instance.

◆ AsString() [1/2]

String MsgPack.MessagePackObject.AsString ( )

Convert this instance to String instance.

Returns
String instance corresponds to this instance.

◆ AsString() [2/2]

string MsgPack.MessagePackObject.AsString ( Encoding  encoding)

Gets the underlying value as string encoded with specified Encoding.

Returns
The string. Note that some Encoding returns null if the binary is not valid encoded string.

◆ AsStringUtf16()

string MsgPack.MessagePackObject.AsStringUtf16 ( )

Get underlying value as UTF-16 string.

Returns
Underlying string.

This method detects BOM. If BOM is not exist, them bytes should be Big-Endian UTF-16.

◆ AsStringUtf8()

string MsgPack.MessagePackObject.AsStringUtf8 ( )

Get underlying value as UTF8 string.

Returns
Underlying raw binary.

◆ AsTimestamp()

Timestamp MsgPack.MessagePackObject.AsTimestamp ( )

Gets a this object as a Timestamp value.

Returns
A Timestamp value.
Exceptions
InvalidOperationExceptionThis object does not represent Timestamp value.

◆ AsUInt16()

UInt16 MsgPack.MessagePackObject.AsUInt16 ( )

Convert this instance to UInt16 instance.

Returns
UInt16 instance corresponds to this instance.

◆ AsUInt32()

UInt32 MsgPack.MessagePackObject.AsUInt32 ( )

Convert this instance to UInt32 instance.

Returns
UInt32 instance corresponds to this instance.

◆ AsUInt64()

UInt64 MsgPack.MessagePackObject.AsUInt64 ( )

Convert this instance to UInt64 instance.

Returns
UInt64 instance corresponds to this instance.

◆ Equals() [1/2]

bool MsgPack.MessagePackObject.Equals ( MessagePackObject  other)

Compare two instances are equal.

Parameters
otherMessagePackObject instance.
Returns
Whether value of other is equal to this instance or not.

◆ Equals() [2/2]

override bool MsgPack.MessagePackObject.Equals ( Object  obj)

Compare two instances are equal.

Parameters
objMessagePackObject instance.
Returns
If obj is MessagePackObject and its value is equal to this instance, then true. Otherwise false.

◆ FromObject()

static MessagePackObject MsgPack.MessagePackObject.FromObject ( object  boxedValue)
static

Wraps specified object as MessagePackObject recursively.

Parameters
boxedValueObject to be wrapped.
Returns
MessagePackObject wrapps boxedValue .
Exceptions
MessageTypeExceptionboxedValue is not primitive value type, list of MessagePackObject, dictionary of MessagePackObject, String, Byte[], or null.

◆ GetHashCode()

override int MsgPack.MessagePackObject.GetHashCode ( )

Get hash code of this instance.

Returns
Hash code of this instance.

◆ IsTypeOf()

bool? MsgPack.MessagePackObject.IsTypeOf ( Type  type)

Determine whether the underlying value of this instance is specified type or not.

Parameters
typeTarget type.
Returns
If the underlying value of this instance is type then true, otherwise false.
Exceptions
ArgumentNullExceptiontype is null.

◆ IsTypeOf< T >()

Determine whether the underlying value of this instance is specified type or not.

Template Parameters
TTarget type.
Returns
If the underlying value of this instance is T then true, otherwise false.

◆ operator Boolean()

static MsgPack.MessagePackObject.operator Boolean ( MessagePackObject  value)
explicitstatic

Convert this instance to Boolean instance.

Parameters
valueMessagePackObject instance.
Returns
Boolean instance corresponds to value .

◆ operator Byte()

static MsgPack.MessagePackObject.operator Byte ( MessagePackObject  value)
explicitstatic

Convert this instance to Byte instance.

Parameters
valueMessagePackObject instance.
Returns
Byte instance corresponds to value .

◆ operator Byte[]()

static MsgPack.MessagePackObject.operator Byte[] ( MessagePackObject  value)
explicitstatic

Convert this instance to Byte[] instance.

Parameters
valueMessagePackObject instance.
Returns
Byte[] instance corresponds to value .

◆ operator Double()

static MsgPack.MessagePackObject.operator Double ( MessagePackObject  value)
explicitstatic

Convert this instance to Double instance.

Parameters
valueMessagePackObject instance.
Returns
Double instance corresponds to value .

◆ operator Int16()

static MsgPack.MessagePackObject.operator Int16 ( MessagePackObject  value)
explicitstatic

Convert this instance to Int16 instance.

Parameters
valueMessagePackObject instance.
Returns
Int16 instance corresponds to value .

◆ operator Int32()

static MsgPack.MessagePackObject.operator Int32 ( MessagePackObject  value)
explicitstatic

Convert this instance to Int32 instance.

Parameters
valueMessagePackObject instance.
Returns
Int32 instance corresponds to value .

◆ operator Int64()

static MsgPack.MessagePackObject.operator Int64 ( MessagePackObject  value)
explicitstatic

Convert this instance to Int64 instance.

Parameters
valueMessagePackObject instance.
Returns
Int64 instance corresponds to value .

◆ operator MessagePackExtendedTypeObject()

static MsgPack.MessagePackObject.operator MessagePackExtendedTypeObject ( MessagePackObject  value)
explicitstatic

Convert this instance to MessagePackExtendedTypeObject instance.

Parameters
valueMessagePackObject instance.
Returns
MessagePackExtendedTypeObject instance corresponds to value .

◆ operator MessagePackObject() [1/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Boolean  value)
static

Convert Booleaninstance to MessagePackObject instance.

Parameters
valueBoolean instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [2/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Byte  value)
static

Convert Byteinstance to MessagePackObject instance.

Parameters
valueByte instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [3/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Byte[]  value)
static

Convert Byte[]instance to MessagePackObject instance.

Parameters
valueByte[] instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [4/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Double  value)
static

Convert Doubleinstance to MessagePackObject instance.

Parameters
valueDouble instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [5/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Int16  value)
static

Convert Int16instance to MessagePackObject instance.

Parameters
valueInt16 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [6/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Int32  value)
static

Convert Int32instance to MessagePackObject instance.

Parameters
valueInt32 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [7/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Int64  value)
static

Convert Int64instance to MessagePackObject instance.

Parameters
valueInt64 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [8/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( MessagePackExtendedTypeObject  value)
static

Convert MessagePackExtendedTypeObjectinstance to MessagePackObject instance.

Parameters
valueMessagePackExtendedTypeObject instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [9/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( MessagePackObject[]  value)
static

Convert MessagePackObject[] instance to MessagePackObject instance.

Parameters
valueMessagePackObject[] instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [10/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( SByte  value)
static

Convert SByteinstance to MessagePackObject instance.

Parameters
valueSByte instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [11/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( Single  value)
static

Convert Singleinstance to MessagePackObject instance.

Parameters
valueSingle instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [12/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( String  value)
static

Convert Stringinstance to MessagePackObject instance.

Parameters
valueString instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [13/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( UInt16  value)
static

Convert UInt16instance to MessagePackObject instance.

Parameters
valueUInt16 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [14/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( UInt32  value)
static

Convert UInt32instance to MessagePackObject instance.

Parameters
valueUInt32 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator MessagePackObject() [15/15]

static implicit MsgPack.MessagePackObject.operator MessagePackObject ( UInt64  value)
static

Convert UInt64instance to MessagePackObject instance.

Parameters
valueUInt64 instance.
Returns
MessagePackObject instance corresponds to value .

◆ operator SByte()

static MsgPack.MessagePackObject.operator SByte ( MessagePackObject  value)
explicitstatic

Convert this instance to SByte instance.

Parameters
valueMessagePackObject instance.
Returns
SByte instance corresponds to value .

◆ operator Single()

static MsgPack.MessagePackObject.operator Single ( MessagePackObject  value)
explicitstatic

Convert this instance to Single instance.

Parameters
valueMessagePackObject instance.
Returns
Single instance corresponds to value .

◆ operator String()

static MsgPack.MessagePackObject.operator String ( MessagePackObject  value)
explicitstatic

Convert this instance to String instance.

Parameters
valueMessagePackObject instance.
Returns
String instance corresponds to value .

◆ operator UInt16()

static MsgPack.MessagePackObject.operator UInt16 ( MessagePackObject  value)
explicitstatic

Convert this instance to UInt16 instance.

Parameters
valueMessagePackObject instance.
Returns
UInt16 instance corresponds to value .

◆ operator UInt32()

static MsgPack.MessagePackObject.operator UInt32 ( MessagePackObject  value)
explicitstatic

Convert this instance to UInt32 instance.

Parameters
valueMessagePackObject instance.
Returns
UInt32 instance corresponds to value .

◆ operator UInt64()

static MsgPack.MessagePackObject.operator UInt64 ( MessagePackObject  value)
explicitstatic

Convert this instance to UInt64 instance.

Parameters
valueMessagePackObject instance.
Returns
UInt64 instance corresponds to value .

◆ operator!=()

static bool MsgPack.MessagePackObject.operator!= ( MessagePackObject  left,
MessagePackObject  right 
)
static

Compare two instances are not equal.

Parameters
leftMessagePackObject instance.
rightMessagePackObject instance.
Returns
Whether value of left and right are not equal each other or are equal.

◆ operator==()

static bool MsgPack.MessagePackObject.operator== ( MessagePackObject  left,
MessagePackObject  right 
)
static

Compare two instances are equal.

Parameters
leftMessagePackObject instance.
rightMessagePackObject instance.
Returns
Whether value of left and right are equal each other or not.

◆ PackToMessage()

void MsgPack.MessagePackObject.PackToMessage ( Packer  packer,
PackingOptions  options 
)

Packs this instance itself using specified Packer.

Parameters
packerPacker.
optionsPacking options. This value can be null.
Exceptions
ArgumentNullExceptionpacker is null.

◆ ToObject()

object MsgPack.MessagePackObject.ToObject ( )

Get boxed underlying value for this object.

Returns
Boxed underlying value for this object.

◆ ToString()

override string MsgPack.MessagePackObject.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<note> DO NOT use this value programmically. The purpose of this method is informational, so format of this value subject to change. </note>

Member Data Documentation

◆ Nil

readonly MessagePackObject MsgPack.MessagePackObject.Nil = default ( MessagePackObject )
static

Instance represents nil. This is equal to default value.

Property Documentation

◆ IsArray

bool MsgPack.MessagePackObject.IsArray
get

Get the value indicates whether this instance wraps list (array) or not.

This instance wraps list (array) then true.

◆ IsDictionary

bool MsgPack.MessagePackObject.IsDictionary
get

Get the value indicates whether this instance wraps dictionary (map) or not.

This instance wraps dictionary (map) then true.

◆ IsList

bool MsgPack.MessagePackObject.IsList
get

Get the value indicates whether this instance wraps list (array) or not.

This instance wraps list (array) then true.

◆ IsMap

bool MsgPack.MessagePackObject.IsMap
get

Get the value indicates whether this instance wraps dictionary (map) or not.

This instance wraps dictionary (map) then true.

◆ IsNil

bool MsgPack.MessagePackObject.IsNil
get

Get whether this instance represents nil.

If this instance represents nil object, then true.

◆ IsRaw

bool MsgPack.MessagePackObject.IsRaw
get

Get the value indicates whether this instance wraps raw binary (or string) or not.

This instance wraps raw binary (or string) then true.

◆ UnderlyingType

Type MsgPack.MessagePackObject.UnderlyingType
get

Get underlying type of this instance.

Returns
Underlying Type.

The documentation for this struct was generated from the following files:
  • MsgPackSources/MessagePackObject.cs
  • MsgPackSources/MessagePackObject.Utilities.cs