Show / Hide Table of Contents

# Interface IBinaryReader

Reader for binary objects.

###### Namespace: Apache.Ignite.Core.Binary

###### Assembly: Apache.Ignite.Core.dll

##### Syntax

    public interface IBinaryReader

### Methods

#### GetRawReader()

Get raw reader.

##### Declaration

    IBinaryRawReader GetRawReader()

##### Returns

Type | Description
--- | ---
IBinaryRawReader | Raw reader.

#### ReadArray<T>(String)

Read named object array.

##### Declaration

    T[] ReadArray<T>(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
T[] | Object array.

##### Type Parameters

Name | Description
--- | ---
T |

#### ReadBoolean(String)

Read named boolean value.

##### Declaration

    bool ReadBoolean(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Boolean | Boolean value.

#### ReadBooleanArray(String)

Read named boolean array.

##### Declaration

    bool[] ReadBooleanArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Boolean[] | Boolean array.

#### ReadByte(String)

Read named byte value.

##### Declaration

    byte ReadByte(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Byte | Byte value.

#### ReadByteArray(String)

Read named byte array.

##### Declaration

    byte[] ReadByteArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName |

##### Returns

Type | Description
--- | ---
System.Byte[] | Byte array.

#### ReadChar(String)

Read named char value.

##### Declaration

    char ReadChar(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Char | Char value.

#### ReadCharArray(String)

Read named char array.

##### Declaration

    char[] ReadCharArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName |

##### Returns

Type | Description
--- | ---
System.Char[] | Char array.

#### ReadCollection(String)

Read named collection.

##### Declaration

    ICollection ReadCollection(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Collections.ICollection | Collection.

#### ReadCollection(String, Func<Int32, ICollection>, Action<ICollection, Object>)

Read named collection.

##### Declaration

    ICollection ReadCollection(string fieldName, Func<int, ICollection> factory, Action<ICollection, object> adder)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.
System.Func<System.Int32, System.Collections.ICollection> | factory | Factory.
System.Action<System.Collections.ICollection, System.Object> | adder | Adder.

##### Returns

Type | Description
--- | ---
System.Collections.ICollection | Collection.

#### ReadDecimal(String)

Read named decimal value.

##### Declaration

    decimal ? ReadDecimal(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.Decimal> | Decimal value.

#### ReadDecimalArray(String)

Read named decimal array.

##### Declaration

    decimal ? [] ReadDecimalArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.Decimal>[] | Decimal array.

#### ReadDictionary(String)

Read named dictionary.

##### Declaration

    IDictionary ReadDictionary(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Collections.IDictionary | Dictionary.

#### ReadDictionary(String, Func<Int32, IDictionary>)

Read named dictionary.

##### Declaration

    IDictionary ReadDictionary(string fieldName, Func<int, IDictionary> factory)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.
System.Func<System.Int32, System.Collections.IDictionary> | factory | Factory.

##### Returns

Type | Description
--- | ---
System.Collections.IDictionary | Dictionary.

#### ReadDouble(String)

Read named double value.

##### Declaration

    double ReadDouble(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Double | Double value.

#### ReadDoubleArray(String)

Read named double array.

##### Declaration

    double[] ReadDoubleArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Double[] | Double array.

#### ReadEnum<T>(String)

Read named enum value.

##### Declaration

    T ReadEnum<T>(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
T | Enum value.

##### Type Parameters

Name | Description
--- | ---
T |

#### ReadEnumArray<T>(String)

Read named enum array.

##### Declaration

    T[] ReadEnumArray<T>(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
T[] | Enum array.

##### Type Parameters

Name | Description
--- | ---
T |

#### ReadFloat(String)

Read named float value.

##### Declaration

    float ReadFloat(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Single | Float value.

#### ReadFloatArray(String)

Read named float array.

##### Declaration

    float[] ReadFloatArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Single[] | Float array.

#### ReadGuid(String)

Read named GUID value.

##### Declaration

    Guid? ReadGuid(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.Guid> | GUID value.

#### ReadGuidArray(String)

Read named GUID array.

##### Declaration

    Guid? [] ReadGuidArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.Guid>[] | GUID array.

#### ReadInt(String)

Read named int value.

##### Declaration

    int ReadInt(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Int32 | Int value.

#### ReadIntArray(String)

Read named int array.

##### Declaration

    int[] ReadIntArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Int32[] | Int array.

#### ReadLong(String)

Read named long value.

##### Declaration

    long ReadLong(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Int64 | Long value.

#### ReadLongArray(String)

Read named long array.

##### Declaration

    long[] ReadLongArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Int64[] | Long array.

#### ReadObject<T>(String)

Read named object.

##### Declaration

    T ReadObject<T>(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
T | Object.

##### Type Parameters

Name | Description
--- | ---
T |

#### ReadShort(String)

Read named short value.

##### Declaration

    short ReadShort(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Int16 | Short value.

#### ReadShortArray(String)

Read named short array.

##### Declaration

    short[] ReadShortArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName |

##### Returns

Type | Description
--- | ---
System.Int16[] | Short array.

#### ReadString(String)

Read named string value.

##### Declaration

    string ReadString(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.String | String value.

#### ReadStringArray(String)

Read named string array.

##### Declaration

    string[] ReadStringArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.String[] | String array.

#### ReadTimestamp(String)

Read named date value in UTC form.

##### Declaration

    DateTime? ReadTimestamp(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.DateTime> | Date value.

#### ReadTimestampArray(String)

Read named date array in UTC form.

##### Declaration

    DateTime? [] ReadTimestampArray(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
System.Nullable<System.DateTime>[] | Date array.