MsgPack.UnpackingResult< T > Struct Template Reference

Represents result of direct conversion from the byte array. More...

Inherits IEquatable< UnpackingResult< T >>.

Public Member Functions

override bool Equals (object obj)
 Compare two instances are equal. More...
 
bool Equals (UnpackingResult< T > other)
 Compare two instances are equal. More...
 
override int GetHashCode ()
 Get hash code of this instance. More...
 
override string ToString ()
 Get string representation of this object. More...
 

Static Public Member Functions

static bool operator== (UnpackingResult< T > left, UnpackingResult< T > right)
 Compare two instances are equal. More...
 
static bool operator!= (UnpackingResult< T > left, UnpackingResult< T > right)
 Compare two instances are not equal. More...
 

Properties

int ReadCount [get]
 Get read bytes count from input byte array. More...
 
Value [get]
 Get retrieved value from the byte array. More...
 

Detailed Description

Represents result of direct conversion from the byte array.

Template Parameters
TType of value.

Member Function Documentation

◆ Equals() [1/2]

override bool MsgPack.UnpackingResult< T >.Equals ( object  obj)

Compare two instances are equal.

Parameters
objUnpackingResult<T> instance.
Returns
If obj is UnpackingResult<T> and its value is equal to this instance, then true. Otherwise false.

◆ Equals() [2/2]

bool MsgPack.UnpackingResult< T >.Equals ( UnpackingResult< T >  other)

Compare two instances are equal.

Parameters
otherUnpackingResult<T> instance.
Returns
Whether value of other is equal to this instance or not.

◆ GetHashCode()

override int MsgPack.UnpackingResult< T >.GetHashCode ( )

Get hash code of this instance.

Returns
Hash code of this instance.

◆ operator!=()

static bool MsgPack.UnpackingResult< T >.operator!= ( UnpackingResult< T >  left,
UnpackingResult< T >  right 
)
static

Compare two instances are not equal.

Parameters
leftUnpackingResult<T> instance.
rightUnpackingResult<T> instance.
Returns
Whether value of left and right are not equal each other or are equal.


◆ operator==()

static bool MsgPack.UnpackingResult< T >.operator== ( UnpackingResult< T >  left,
UnpackingResult< T >  right 
)
static

Compare two instances are equal.

Parameters
leftUnpackingResult<T> instance.
rightUnpackingResult<T> instance.
Returns
Whether value of left and right are equal each other or not.

◆ ToString()

override string MsgPack.UnpackingResult< T >.ToString ( )

Get string representation of this object.

Returns
String representation of this object.

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

Property Documentation

◆ ReadCount

int MsgPack.UnpackingResult< T >.ReadCount
get

Get read bytes count from input byte array.

Read bytes count from input byte array. If this value equals to old offset, then a value of Value property is not undifined.

◆ Value

T MsgPack.UnpackingResult< T >.Value
get

Get retrieved value from the byte array.

Retrieved value from the byte array. If ReadCount equals to old offset, then a value of this property is not undefined.


The documentation for this struct was generated from the following file:
  • MsgPackSources/UnpackingResult.cs