Detailed Description

Tools for handling binary operations with a data.

Methods that required to serialization and deserialization. Place it to the target classes that will be used in save system.

[System.Serializable]
class YourCalss : System.Runtime.Serialization.ISerializable
{
    // Allows to binary serializer instantiate the object from binary.
    public YourClass(SerializationInfo info, StreamingContext context)
    {
        BinarySerializationTool.OverrideInstanceData<YourClass>(this, info);
    }
 
    // Calling by binary serializer to get object's data.
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        if (info == null) throw new System.ArgumentNullException("info");
        BinarySerializationTool.ToBinary(this, info);
    }
}

Static Public Member Functions
static T	BinaryToInstance< T > (SerializationInfo info)
	Decodes binary data to the instance of certain type. More...

static void	OverrideInstanceData< T > (T obj, SerializationInfo info)
	Decodes binary data to the instance of certain type above existed one. More...

static void	ToBinary (object obj, SerializationInfo info)
	Encodes object to the binary format. More...

static void	Serialize (object obj, string fullPath)
	Serializes data container to the file. More...

static void	Serialize (object obj, string fullPath, BinaryFormatter formatter)
	Serializes data container to the file. More...

static void	Serialize (object obj, out byte[] data)
	Serializes data container to the binary array. More...

static void	Serialize (object obj, out byte[] data, BinaryFormatter formatter)
	Serializes data container to the binary array. More...

static T	Deserialize< T > (byte[] data)
	Deserializes data from the binary array. More...

static T	Deserialize< T > (string fullPath)
	Deserializes data container from the file and return as object. More...

static T	Deserialize< T > (Stream stream)
	Deserializes data container from the file and return as object. More...

static object	Deserialize (byte[] data, BinaryFormatter formatter)
	Deserializes data from the binary array. More...

static object	Deserialize (byte[] data)
	Deserializes data from the binary array. More...

static object	Deserialize (string fullPath)
	Deserializes data container from the file and return as object. More...

static object	Deserialize (string fullPath, BinaryFormatter formatter)
	Deserializes data container from the file and return as object. More...

static object	Deserialize (Stream stream)
	Deserializes data container from the file and return as object. More...

static object	Deserialize (Stream stream, BinaryFormatter formatter)
	Deserializes data container from the file and return as object. More...

Properties
static bool	UNITY_LOGS_ON = true `[get, set]`
	If true then will spawn `UnityEngine.Debug.Log`.

static bool	LogsBuild = false `[get, set]`
	If true then will generates loading log.

static string	Logs `[get]`
	Logs generated on the last pass.

Events
static Action	LogsGenerated
	Occurs when new pass of Logs generated.

Member Function Documentation

◆ BinaryToInstance< T >()

static T Doloro.DataManagement.Serialization.BinarySerializationTool.BinaryToInstance< T > ( SerializationInfo info )

static

Decodes binary data to the instance of certain type.

Template Parameters

T	Supposed type of binary object.

Parameters

info	Information about object.

Returns: Instance of object.

◆ Deserialize() [1/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize ( byte[] data )

static

Deserializes data from the binary array.

Parameters

data	Object in binary format.

Returns: Deserialized object.

◆ Deserialize() [2/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize	(	byte[]	data,
		BinaryFormatter	formatter
	)

static

Deserializes data from the binary array.

Parameters

data	Object in binary format.
formatter	Custom configured binary formatter.

Returns: Deserialized object.

◆ Deserialize() [3/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize ( Stream stream )

static

Deserializes data container from the file and return as object.

Parameters

stream Source stream to binary data reading.

Returns: Instance of the object.

Exceptions

SerializationException Serialization failed.

◆ Deserialize() [4/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize	(	Stream	stream,
		BinaryFormatter	formatter
	)

static

Deserializes data container from the file and return as object.

Parameters

stream Source stream to binary data reading.

Returns: Instance of the object.

Parameters

formatter Custom configured binary formatter.

Exceptions

SerializationException	Serialization failed.
ArgumentNullException	One of arguments is null.
IOException	Stream not allows can't be read.

◆ Deserialize() [5/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize ( string fullPath )

static

Deserializes data container from the file and return as object.

Parameters

fullPath Output relative directory with file name and extension.

Returns: Loaded instance.

Exceptions

SerializationException	Serialization failed.
FileNotFoundException	Destination file not found.

◆ Deserialize() [6/6]

static object Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize	(	string	fullPath,
		BinaryFormatter	formatter
	)

static

Deserializes data container from the file and return as object.

Parameters

fullPath	Output relative directory with file name and extension.
formatter	Custom configured binary formatter.

Returns: Loaded instance.

Exceptions

SerializationException	Serialization failed.
FileNotFoundException	Destination file not found.

◆ Deserialize< T >() [1/3]

static T Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize< T > ( byte[] data )

static

Deserializes data from the binary array.

Template Parameters

T	Expecting data type.

Parameters

data	Object in binary format.

Returns: Deserialized object.

Exceptions

SerializationException Serialization failed.

◆ Deserialize< T >() [2/3]

static T Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize< T > ( Stream stream )

static

Deserializes data container from the file and return as object.

Parameters

stream Source stream to binary data reading.

Returns: Instance of the object.

Exceptions

SerializationException	Serialization failed.
ArgumentNullException	`stream` is `null`
ArgumentException	`stream` is empty.

◆ Deserialize< T >() [3/3]

static T Doloro.DataManagement.Serialization.BinarySerializationTool.Deserialize< T > ( string fullPath )

static

Deserializes data container from the file and return as object.

Parameters

fullPath Output relative directory with file name and extension.

Returns: Loaded instance.

Exceptions

SerializationException	Serialization failed.
FileNotFoundException	Destination file not found.

◆ OverrideInstanceData< T >()

static void Doloro.DataManagement.Serialization.BinarySerializationTool.OverrideInstanceData< T >	(	T	obj,
		SerializationInfo	info
	)

static

Decodes binary data to the instance of certain type above existed one.

Template Parameters

T	Supposed type of binary object.

Parameters

obj	Object those fields fill be overridden with binary data.
info	Information about binary data.

Exceptions

ArgumentNullException Arguments can't be null.

◆ Serialize() [1/4]

static void Doloro.DataManagement.Serialization.BinarySerializationTool.Serialize	(	object	obj,
		out byte[]	data
	)

static

Serializes data container to the binary array.

Parameters

obj	Object for serialization.
data	Output binary array.

Exceptions

ArgumentNullException	`obj` or \ and `formatter` is null.
SerializationException	Serialization failed.

◆ Serialize() [2/4]

static void Doloro.DataManagement.Serialization.BinarySerializationTool.Serialize	(	object	obj,
		out byte[]	data,
		BinaryFormatter	formatter
	)

static

Serializes data container to the binary array.

Parameters

obj	Object for serialization.
data	Output binary array.
formatter	Custom binary formatter.

Exceptions

ArgumentNullException	`obj` or \ and `formatter` is null.
SerializationException	Serialization failed.

◆ Serialize() [3/4]

static void Doloro.DataManagement.Serialization.BinarySerializationTool.Serialize	(	object	obj,
		string	fullPath
	)

static

Serializes data container to the file.

Parameters

obj	Object for serialization.
fullPath	Output relative directory with file name and extension.

Exceptions

ArgumentNullException	`obj` or \ and `formatter` is null.
ArgumentException	`fullPath` is null or whitespace.
SerializationException	Serialization failed.

◆ Serialize() [4/4]

static void Doloro.DataManagement.Serialization.BinarySerializationTool.Serialize	(	object	obj,
		string	fullPath,
		BinaryFormatter	formatter
	)

static

Serializes data container to the file.

Parameters

obj	Object for serialization.
fullPath	Output relative directory with file name and extension.
formatter	Custom binary formatter to use.

Exceptions

ArgumentNullException	`obj` or \ and `formatter` is null.
ArgumentException	`fullPath` is null or whitespace.
SerializationException	Serialization failed.

◆ ToBinary()

static void Doloro.DataManagement.Serialization.BinarySerializationTool.ToBinary	(	object	obj,
		SerializationInfo	info
	)

static

Encodes object to the binary format.

Parameters

obj	Object to binary encoding.
info	Output serialization data.

Ignores fields marked with System.NonSerializedAttribute or NotSerializeAttribute attributes.

Forces serialization of privatefields marked with SerializeAttribute and UnityEngine.SerializeField attributes.

The documentation for this class was generated from the following file:

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Serialization Tools/API/BinarySerializationTool.cs

Detailed Description

Static Public Member Functions

Properties

Events

Member Function Documentation

◆ BinaryToInstance< T >()

◆ Deserialize() [1/6]

◆ Deserialize() [2/6]

◆ Deserialize() [3/6]

◆ Deserialize() [4/6]

◆ Deserialize() [5/6]

◆ Deserialize() [6/6]

◆ Deserialize< T >() [1/3]

◆ Deserialize< T >() [2/3]

◆ Deserialize< T >() [3/3]

◆ OverrideInstanceData< T >()

◆ Serialize() [1/4]

◆ Serialize() [2/4]

◆ Serialize() [3/4]

◆ Serialize() [4/4]

◆ ToBinary()