Class Serializer

Model serializer. Can be used to serialize and deserialize (i.e. save and load) models from the framework to and from the disk and other streams.
Inheritance
System.Object
Serializer
Namespace: Mars.Common.IO
Assembly: Mars.IO.dll
Syntax
public static class Serializer : object

Methods

Load<T>(Stream, out T, SerializerCompression)

Loads an object from a stream.
Declaration
public static T Load<T>(Stream stream, out T value, SerializerCompression compression = default(SerializerCompression))
Parameters
Type Name Description
Stream stream The stream from which the object is to be deserialized.
T value The object to be read. This parameter can be used to avoid the need of specifying a generic argument to this function.
SerializerCompression compression The type of compression to use. Default is None.
Returns
Type Description
T The deserialized machine.
Type Parameters
Name Description
T

Load<T>(Stream, SerializerCompression)

Loads an object from a stream.
Declaration
public static T Load<T>(Stream stream, SerializerCompression compression = default(SerializerCompression))
Parameters
Type Name Description
Stream stream The stream from which the object is to be deserialized.
SerializerCompression compression The type of compression to use. Default is None.
Returns
Type Description
T The deserialized machine.
Type Parameters
Name Description
T

Load<T>(String)

Loads an object from a file.
Declaration
public static T Load<T>(string path)
Parameters
Type Name Description
System.String path The path to the file from which the object is to be deserialized.
Returns
Type Description
T The deserialized object.
Type Parameters
Name Description
T

Load<T>(String, out T)

Loads an object from a file.
Declaration
public static T Load<T>(string path, out T value)
Parameters
Type Name Description
System.String path The path to the file from which the object is to be deserialized.
T value The object to be read. This parameter can be used to avoid the need of specifying a generic argument to this function.
Returns
Type Description
T The deserialized object.
Type Parameters
Name Description
T

Load<T>(String, out T, SerializerCompression)

Loads an object from a file.
Declaration
public static T Load<T>(string path, out T value, SerializerCompression compression)
Parameters
Type Name Description
System.String path The path to the file from which the object is to be deserialized.
T value The object to be read. This parameter can be used to avoid the need of specifying a generic argument to this function.
SerializerCompression compression The type of compression to use. Default is None.
Returns
Type Description
T The deserialized object.
Type Parameters
Name Description
T

Load<T>(String, SerializerCompression)

Loads an object from a file.
Declaration
public static T Load<T>(string path, SerializerCompression compression)
Parameters
Type Name Description
System.String path The path to the file from which the object is to be deserialized.
SerializerCompression compression The type of compression to use. Default is None.
Returns
Type Description
T The deserialized object.
Type Parameters
Name Description
T

Save<T>(T, BinaryFormatter, Stream, SerializerCompression)

Saves an object to a stream.
Declaration
public static void Save<T>(this T obj, BinaryFormatter formatter, Stream stream, SerializerCompression compression = default(SerializerCompression))
Parameters
Type Name Description
T obj The object to be serialized.
BinaryFormatter formatter The binary formatter.
Stream stream The stream to which the object is to be serialized.
SerializerCompression compression The type of compression to use. Default is None.
Type Parameters
Name Description
T

Save<T>(T, Stream, SerializerCompression)

Saves an object to a stream.
Declaration
public static void Save<T>(this T obj, Stream stream, SerializerCompression compression = default(SerializerCompression))
Parameters
Type Name Description
T obj The object to be serialized.
Stream stream The stream to which the object is to be serialized.
SerializerCompression compression The type of compression to use. Default is None.
Type Parameters
Name Description
T

Save<T>(T, out Byte[], SerializerCompression)

Saves an object to a stream.
Declaration
public static void Save<T>(this T obj, out byte[] bytes, SerializerCompression compression = default(SerializerCompression))
Parameters
Type Name Description
T obj The object to be serialized.
System.Byte[] bytes The sequence of bytes to which the object has been serialized.
SerializerCompression compression The type of compression to use. Default is None.
Type Parameters
Name Description
T

Save<T>(T, String)

Saves an object to a stream.
Declaration
public static void Save<T>(this T obj, string path)
Parameters
Type Name Description
T obj The object to be serialized.
System.String path The path to the file to which the object is to be serialized.
Type Parameters
Name Description
T

Save<T>(T, String, SerializerCompression)

Saves an object to a stream.
Declaration
public static void Save<T>(this T obj, string path, SerializerCompression compression)
Parameters
Type Name Description
T obj The object to be serialized.
System.String path The path to the file to which the object is to be serialized.
SerializerCompression compression The type of compression to use. Default is None.
Type Parameters
Name Description
T