Version 2.1.0.0

SerializationNodeDataReader class

Namespace: Sirenix.Serialization
Assembly: Sirenix.Serialization
public class SerializationNodeDataReader : BaseDataReader, IDataReader, IDisposable
Not yet documented.
Inheritance

Constructors

SerializationNodeDataReader(DeserializationContext)
Not yet documented.
public SerializationNodeDataReader(DeserializationContext context)
Parameters
DeserializationContext context

Properties

Nodes
Not yet documented.
public List<SerializationNode> Nodes { get; set; }
Stream
Not yet documented.
public override Stream Stream { get; set; }

Methods

Dispose()
Not yet documented.
public override void Dispose()
EnterArray(out Int64)
Tries to enters an array node. This will succeed if the next entry is an StartOfArray.

This call MUST (eventually) be followed by a corresponding call to

This call will change the values of the Sirenix.Serialization.IDataReader.IsInArrayNode, Sirenix.Serialization.IDataReader.CurrentNodeName, Sirenix.Serialization.IDataReader.CurrentNodeId and Sirenix.Serialization.IDataReader.CurrentNodeDepth properties to the correct values for the current array node.

public override bool EnterArray(out long length)
Parameters
System.Int64 length

The length of the array that was entered.

Returns
System.Boolean

true if an array was entered, otherwise false

EnterNode(out Type)
Not yet documented.
public override bool EnterNode(out Type type)
Parameters
System.Type type

Returns
System.Boolean

ExitArray()
Not yet documented.
public override bool ExitArray()
Returns
System.Boolean

ExitNode()
Not yet documented.
public override bool ExitNode()
Returns
System.Boolean

GetDataDump()
public override string GetDataDump()
Returns
System.String

PeekEntry()
Peeks the current entry.
protected override EntryType PeekEntry()
Returns
EntryType

The peeked entry.

PeekEntry(out String)
Not yet documented.
public override EntryType PeekEntry(out string name)
Parameters
System.String name

Returns
EntryType

PrepareNewSerializationSession()
Not yet documented.
public override void PrepareNewSerializationSession()
ReadBoolean(out Boolean)
Not yet documented.
public override bool ReadBoolean(out bool value)
Parameters
System.Boolean value

Returns
System.Boolean

ReadByte(out Byte)
Not yet documented.
public override bool ReadByte(out byte value)
Parameters
System.Byte value

Returns
System.Boolean

ReadChar(out Char)
Not yet documented.
public override bool ReadChar(out char value)
Parameters
System.Char value

Returns
System.Boolean

ReadDecimal(out Decimal)
Not yet documented.
public override bool ReadDecimal(out decimal value)
Parameters
System.Decimal value

Returns
System.Boolean

ReadDouble(out Double)
Not yet documented.
public override bool ReadDouble(out double value)
Parameters
System.Double value

Returns
System.Boolean

ReadExternalReference(out Guid)
Not yet documented.
public override bool ReadExternalReference(out Guid guid)
Parameters
System.Guid guid

Returns
System.Boolean

ReadExternalReference(out Int32)
Not yet documented.
public override bool ReadExternalReference(out int index)
Parameters
System.Int32 index

Returns
System.Boolean

ReadExternalReference(out String)
Not yet documented.
public override bool ReadExternalReference(out string id)
Parameters
System.String id

Returns
System.Boolean

ReadGuid(out Guid)
Not yet documented.
public override bool ReadGuid(out Guid value)
Parameters
System.Guid value

Returns
System.Boolean

ReadInt16(out Int16)
Not yet documented.
public override bool ReadInt16(out short value)
Parameters
System.Int16 value

Returns
System.Boolean

ReadInt32(out Int32)
Not yet documented.
public override bool ReadInt32(out int value)
Parameters
System.Int32 value

Returns
System.Boolean

ReadInt64(out Int64)
Not yet documented.
public override bool ReadInt64(out long value)
Parameters
System.Int64 value

Returns
System.Boolean

ReadInternalReference(out Int32)
Not yet documented.
public override bool ReadInternalReference(out int id)
Parameters
System.Int32 id

Returns
System.Boolean

ReadNull()
Not yet documented.
public override bool ReadNull()
Returns
System.Boolean

ReadPrimitiveArray<T>(out T[])
Reads a primitive array value. This call will succeed if the next entry is an PrimitiveArray.

If the call fails (and returns false), it will skip the current entry value, unless that entry is an EndOfNode or an EndOfArray.

public override bool ReadPrimitiveArray<T>(out T[] array)
    where T : struct
Parameters
T[] array

The resulting primitive array.

Returns
System.Boolean

true if reading a primitive array succeeded, otherwise false

Type Parameters
T

The element type of the primitive array. Valid element types can be determined using IsPrimitiveArrayType(Type).

Exceptions
System.ArgumentException

Type + typeof(T).Name + is not a valid primitive array type.

ReadSByte(out SByte)
Not yet documented.
public override bool ReadSByte(out sbyte value)
Parameters
System.SByte value

Returns
System.Boolean

ReadSingle(out Single)
Not yet documented.
public override bool ReadSingle(out float value)
Parameters
System.Single value

Returns
System.Boolean

ReadString(out String)
Not yet documented.
public override bool ReadString(out string value)
Parameters
System.String value

Returns
System.Boolean

ReadToNextEntry()
Consumes the current entry, and reads to the next one.
protected override EntryType ReadToNextEntry()
Returns
EntryType

The next entry.

ReadUInt16(out UInt16)
Not yet documented.
public override bool ReadUInt16(out ushort value)
Parameters
System.UInt16 value

Returns
System.Boolean

ReadUInt32(out UInt32)
Not yet documented.
public override bool ReadUInt32(out uint value)
Parameters
System.UInt32 value

Returns
System.Boolean

ReadUInt64(out UInt64)
Not yet documented.
public override bool ReadUInt64(out ulong value)
Parameters
System.UInt64 value

Returns
System.Boolean

This website is brand new and built with the Odin 2.1 beta in mind. This means you might discover some features such as attribute expressions that are only available in the beta.

You can download the 2.1 beta from here and read the patch-notes here.