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.

Inheritance Hierarchy

SystemObject
System.IOBinaryReader
SD.LLBLGen.Pro.ORMSupportClassesSerializationReader

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

public sealed class SerializationReader : BinaryReader

Public NotInheritable Class SerializationReader
	Inherits BinaryReader

The SerializationReader type exposes the following members.

Constructors

	Name	Description
	SerializationReader(Byte)	Creates a SerializationReader using a byte[] previous created by SerializationWriter A MemoryStream is used to access the data without making a copy of it.
	SerializationReader(Stream)	Creates a SerializationReader based on the passed Stream.
	SerializationReader(Stream, Boolean)	Initializes a new instance of the SerializationReader class.
	SerializationReader(Stream, Int32, Int32)	Creates a SerializationReader based around the passed Stream. Allows the string and object token tables to be presized using the specified values.

Top

Properties

	Name	Description
	BaseStream	Exposes access to the underlying stream of the BinaryReader. (Inherited from BinaryReader.)
	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.

Top

Methods

	Name	Description
	Close	Closes the current reader and the underlying stream. (Inherited from BinaryReader.)
	Dispose	Releases all resources used by the current instance of the BinaryReader class. (Inherited from BinaryReader.)
	DumpStringTables	Dumps the string tables.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	PeekChar	Returns the next available character and does not advance the byte or character position. (Inherited from BinaryReader.)
	Read	Reads characters from the underlying stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream. (Inherited from BinaryReader.)
	Read(Char, Int32, Int32)	Reads the specified number of characters from the stream, starting from a specified point in the character array. (Inherited from BinaryReader.)
	Read(Byte, Int32, Int32)	Reads the specified number of bytes from the stream, starting from a specified point in the byte array. (Inherited from BinaryReader.)
	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.
	ReadBoolean	Reads a Boolean value from the current stream and advances the current position of the stream by one byte. (Inherited from BinaryReader.)
	ReadBooleanArray	Returns a Boolean[] from the stream.
	ReadByte	Reads the next byte from the current stream and advances the current position of the stream by one byte. (Inherited from BinaryReader.)
	ReadByteArray	Returns a Byte[] from the stream.
	ReadBytes	Reads the specified number of bytes from the current stream into a byte array and advances the current position by that number of bytes. (Inherited from BinaryReader.)
	ReadBytesDirect	Reads the specified number of bytes directly from the stream.
	ReadChar	Reads the next character from the current stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream. (Inherited from BinaryReader.)
	ReadCharArray	Returns a Char[] from the stream.
	ReadChars	Reads the specified number of characters from the current stream, returns the data in a character array, and advances the current position in accordance with the Encoding used and the specific character being read from the stream. (Inherited from BinaryReader.)
	ReadDateTime	Returns a DateTime value from the stream.
	ReadDateTimeArray	Returns a DateTime[] from the stream.
	ReadDecimal	Reads a decimal value from the current stream and advances the current position of the stream by sixteen bytes. (Inherited from BinaryReader.)
	ReadDecimalArray	Returns a Decimal[] from the stream.
	ReadDictionaryK, V	Returns a new, simple generic dictionary populated with keys and values from the stream.
	ReadDictionaryK, V(DictionaryK, 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.
	ReadDouble	Reads an 8-byte floating point value from the current stream and advances the current position of the stream by eight bytes. (Inherited from BinaryReader.)
	ReadDoubleArray	Returns a Double[] from the stream.
	ReadGuid	Returns a Guid value from the stream.
	ReadGuidArray	Returns a Guid[] from the stream.
	ReadInt16	Reads a 2-byte signed integer from the current stream and advances the current position of the stream by two bytes. (Inherited from BinaryReader.)
	ReadInt16Array	Returns an Int16[] from the stream.
	ReadInt32	Reads a 4-byte signed integer from the current stream and advances the current position of the stream by four bytes. (Inherited from BinaryReader.)
	ReadInt32Array	Returns an Int32[] from the stream.
	ReadInt64	Reads an 8-byte signed integer from the current stream and advances the current position of the stream by eight bytes. (Inherited from BinaryReader.)
	ReadInt64Array	Returns an Int64[] from the stream.
	ReadListT	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.
	ReadOptimizedInt16	Returns an Int16 value from the stream that was stored optimized.
	ReadOptimizedInt16Array	Returns a Int16[] 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.
	ReadOptimizedUInt16	Returns a UInt16 value from the stream that was stored optimized.
	ReadOptimizedUInt16Array	Returns a UInt16[] from the stream.
	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.
	ReadSByte	Reads a signed byte from this stream and advances the current position of the stream by one byte. (Inherited from BinaryReader.)
	ReadSByteArray	Returns an SByte[] from the stream.
	ReadSingle	Reads a 4-byte floating point value from the current stream and advances the current position of the stream by four bytes. (Inherited from BinaryReader.)
	ReadSingleArray	Returns a Single[] from the stream.
	ReadString	Called ReadOptimizedString(). This override to hide base BinaryReader.ReadString(). (Overrides BinaryReaderReadString.)
	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.
	ReadUInt16	Reads a 2-byte unsigned integer from the current stream using little-endian encoding and advances the position of the stream by two bytes. (Inherited from BinaryReader.)
	ReadUInt16Array	Returns a UInt16[] from the stream.
	ReadUInt32	Reads a 4-byte unsigned integer from the current stream and advances the position of the stream by four bytes. (Inherited from BinaryReader.)
	ReadUInt32Array	Returns a UInt[] from the stream.
	ReadUInt64	Reads an 8-byte unsigned integer from the current stream and advances the position of the stream by eight bytes. (Inherited from BinaryReader.)
	ReadUInt64Array	Returns a UInt64[] from the stream.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace