SerializationReader Class

A SerializationReader instance is used to read stored values and objects from a byte array. Once an instance is created, use the various methods to read the required data. The data read MUST be exactly the same type and in the same order as it was written.

Namespace: SobekCM.Core.MemoryMgmt
Assembly: SobekCM_Core (in SobekCM_Core.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public sealed class SerializationReader : BinaryReader

Inheritance Hierarchy

System..::..Object
System.IO..::..BinaryReader
SobekCM.Core.MemoryMgmt..::..SerializationReader

Constructors

	Name	Description
	SerializationReader	Creates a SerializationReader using a byte[] previous created by SerializationWriter A MemoryStream is used to access the data without making a copy of it.

Methods

	Name	Description
	DumpStringTables	Dump string table during debugging
	ReadArrayList	Returns an ArrayList or null from the stream.
	ReadBitArray	Returns a BitArray or null from the stream.
	ReadBitVector32	Returns a BitVector32 value from the stream.
	ReadBooleanArray	Returns a Boolean[] from the stream.
	ReadByteArray	Returns a Byte[] from the stream.
	ReadBytesDirect	Reads the specified number of bytes directly from the stream.
	ReadCharArray	Returns a Char[] from the stream.
	ReadDateTime	Returns a DateTime value from the stream.
	ReadDateTimeArray	Returns a DateTime[] from the stream.
	ReadDecimalArray	Returns a Decimal[] from the stream.
	ReadDictionary<(Of <<'(K, V>)>>)()()()()	Returns a new, simple generic dictionary populated with keys and values from the stream.
	ReadDictionary<(Of <<'(K, V>)>>)(Dictionary<(Of <<'(K, V>)>>))	Populates a pre-existing generic dictionary with keys and values from the stream. This allows a generic dictionary to be created without using the default constructor.
	ReadDoubleArray	Returns a Double[] from the stream.
	ReadGuid	Returns a Guid value from the stream.
	ReadGuidArray	Returns a Guid[] from the stream.
	ReadInt16Array	Returns an Int16[] from the stream.
	ReadInt32Array	Returns an Int32[] from the stream.
	ReadInt64Array	Returns an Int64[] from the stream.
	ReadList<(Of <<'(T>)>>)	Returns a generic List populated with values from the stream.
	ReadNullable	Returns a Nullable struct from the stream. The value returned must be cast to the correct Nullable type. Synonym for ReadObject();
	ReadNullableBoolean	Returns a Nullable Boolean from the stream.
	ReadNullableByte	Returns a Nullable Byte from the stream.
	ReadNullableChar	Returns a Nullable Char from the stream.
	ReadNullableDateTime	Returns a Nullable DateTime from the stream.
	ReadNullableDecimal	Returns a Nullable Decimal from the stream.
	ReadNullableDouble	Returns a Nullable Double from the stream.
	ReadNullableGuid	Returns a Nullable Guid from the stream.
	ReadNullableInt16	Returns a Nullable Int16 from the stream.
	ReadNullableInt32	Returns a Nullable Int32 from the stream.
	ReadNullableInt64	Returns a Nullable Int64 from the stream.
	ReadNullableSByte	Returns a Nullable SByte from the stream.
	ReadNullableSingle	Returns a Nullable Single from the stream.
	ReadNullableTimeSpan	Returns a Nullable TimeSpan from the stream.
	ReadNullableUInt16	Returns a Nullable UInt16 from the stream.
	ReadNullableUInt32	Returns a Nullable UInt32 from the stream.
	ReadNullableUInt64	Returns a Nullable UInt64 from the stream.
	ReadObject	Returns an object based on the SerializedType read next from the stream.
	ReadObjectArray()()()()	Returns an object[] or null from the stream.
	ReadObjectArray(Type)	Returns an object[] or null from the stream. The returned array will be typed according to the specified element type and the resulting array can be cast to the expected type. e.g. string[] myStrings = (string[]) reader.ReadObjectArray(typeof(string)); An exception will be thrown if any of the deserialized values cannot be cast to the specified elementType.
	ReadOptimizedArrayList	Returns an ArrayList from the stream that was stored optimized.
	ReadOptimizedBitArray	Returns a BitArray from the stream that was stored optimized.
	ReadOptimizedBitVector32	Returns a BitVector32 value from the stream that was stored optimized.
	ReadOptimizedBooleanArray	Returns a Boolean[] from the stream.
	ReadOptimizedDateTime	Returns a DateTime value from the stream that was stored optimized.
	ReadOptimizedDateTimeArray	Returns a DateTime[] from the stream.
	ReadOptimizedDecimal	Returns a Decimal value from the stream that was stored optimized.
	ReadOptimizedDecimalArray	Returns a Decimal[] from the stream.
	ReadOptimizedInt32	Returns an Int32 value from the stream that was stored optimized.
	ReadOptimizedInt32Array	Returns a Int32[] from the stream.
	ReadOptimizedInt64	Returns an Int64 value from the stream that was stored optimized.
	ReadOptimizedInt64Array	Returns a Int64[] from the stream.
	ReadOptimizedObjectArray()()()()	Returns an object[] from the stream that was stored optimized.
	ReadOptimizedObjectArray(Type)	Returns an object[] from the stream that was stored optimized. The returned array will be typed according to the specified element type and the resulting array can be cast to the expected type. e.g. string[] myStrings = (string[]) reader.ReadOptimizedObjectArray(typeof(string)); An exception will be thrown if any of the deserialized values cannot be cast to the specified elementType.
	ReadOptimizedObjectArrayPair	Returns a pair of object[] arrays from the stream that were stored optimized.
	ReadOptimizedString	Returns a string value from the stream that was stored optimized.
	ReadOptimizedStringArray	Returns a string[] from the stream that was stored optimized.
	ReadOptimizedTimeSpan	Returns a TimeSpan value from the stream that was stored optimized.
	ReadOptimizedTimeSpanArray	Returns a TimeSpan[] from the stream.
	ReadOptimizedType()()()()	Returns a Type from the stream. Throws an exception if the Type cannot be found.
	ReadOptimizedType(Boolean)	Returns a Type from the stream. Throws an exception if the Type cannot be found and throwOnError is true.
	ReadOptimizedUInt32	Returns a UInt32 value from the stream that was stored optimized.
	ReadOptimizedUInt32Array	Returns a UInt32[] from the stream.
	ReadOptimizedUInt64	Returns a UInt64 value from the stream that was stored optimized.
	ReadOptimizedUInt64Array	Returns a UInt64[] from the stream.
	ReadOwnedData	Allows an existing object, implementing IOwnedDataSerializable, to retrieve its owned data from the stream.
	ReadSByteArray	Returns an SByte[] from the stream.
	ReadSingleArray	Returns a Single[] from the stream.
	ReadString	Called ReadOptimizedString(). This override to hide base BinaryReader.ReadString(). (Overrides BinaryReader..::..ReadString()()()().)
	ReadStringArray	Returns a string[] or null from the stream.
	ReadStringDirect	Returns a string value from the stream.
	ReadTimeSpan	Returns a TimeSpan value from the stream.
	ReadTimeSpanArray	Returns a TimeSpan[] from the stream.
	ReadTokenizedObject	Returns the object associated with the object token read next from the stream.
	ReadType()()()()	Returns a Type or null from the stream. Throws an exception if the Type cannot be found.
	ReadType(Boolean)	Returns a Type or null from the stream. Throws an exception if the Type cannot be found and throwOnError is true.
	ReadTypedArray	Returns a typed array from the stream.
	ReadUInt16Array	Returns a UInt16[] from the stream.
	ReadUInt32Array	Returns a UInt[] from the stream.
	ReadUInt64Array	Returns a UInt64[] from the stream.

Properties

	Name	Description
	BytesRemaining	Returns the number of bytes or serialized remaining to be processed. Useful for checking that deserialization is complete. Warning: Retrieving the Position in certain stream types can be expensive, e.g. a FileStream, so use sparingly unless known to be a MemoryStream.