Serializer

Description

sealed class Tinman.Core.IO.Serialization.Serializer

Derived from: SerializerStream ^abstract

Default implementation of the ISerializable interface that uses an IDataStream for reading and writing binary data.

Public / Constants

Int32

public static readonly attribute Int32 → (ITypeSerializer<int32>)

An instance of ITypeSerializer for signed 32-bit integers.

VarInt32

public static readonly attribute VarInt32 → (ITypeSerializer<int32>)

An instance of ITypeSerializer for signed 32-bit integers.

See also: IOUtil.VarIntRead¹
IOUtil.VarIntWrite¹

Public / Constructors

For

public static method For → (1)

stream ⁱⁿ : IDataStream: [not-null]
The data stream to use.
returns → Serializer: The created ISerializer object.

Creates a new instance of ISerializer.

Public / Methods

Clone

public static method Clone → (1)

obj ⁱⁿ : ISerializable: The object to clone.
returns → ISerializable: The cloned object.

Clones the given serializable object.

The clone is created by first serializing the given object and then deserializing the clone from the binary data stream.

Deserialize

_3 overloads

[OwnerReturn]
public static method Deserialize¹ → (1)

stream ⁱⁿ : IDataStream ^own: [not-null]
The data stream.
returns → ISerializable: The deserialized object or null.

Deserializes an object from the given data stream.

IOException: If an I/O error has occurred or if the data in stream ⁱⁿ is malformed.

[OwnerReturn]
public static method Deserialize² → (1)

buffer ⁱⁿ : ByteBuffer ^own: The byte buffer.
returns → ISerializable: The deserialized object or null if the serialized object was null or buffer ⁱⁿ is null.

Deserializes an object from the given byte buffer.

ByteOrder.LittleEndian will be used for reading multi-byte values.

IOException: If the data in buffer ⁱⁿ is malformed.

[OwnerReturn]
public static method Deserialize³ → (1)

file ⁱⁿ : Path: [not-null]
The file path.
returns → ISerializable: The deserialized object or null.

Deserializes an object from the given file.

ByteOrder.LittleEndian will be used for reading multi-byte values.

IOException: If an I/O error has occurred or if the data in file ⁱⁿ is malformed.

Serialize

_3 overloads

[OwnerReturn]
public static method Serialize¹ → (2)

obj ⁱⁿ : ISerializable: The object to serialize or null.
stream ⁱⁿ : IDataStream: [not-null]
The stream to serialize to.

Serializes the given object.

IOException: If an I/O error has occurred.

[OwnerReturn]
public static method Serialize² → (1)

obj ⁱⁿ : ISerializable: The object to serialize or null.
returns → ByteBuffer: The byte buffer that holds the serialized object data.