Ceiralizer 1.1.0

Ceiralizer

Serialize structs and classes to byte array and vice-versa

Nuget: https://www.nuget.org/packages/Ceiralizer

Usage

Declaration

public struct CeiraPacket : IPacket
{
    // PacketFieldAttribute determine if the field is serializable
    [PacketField] public short Op;

    public string Garbage;

    [PacketField] public int Value;
    
    [PacketField] public int[] Ceiras;

    [PacketField] public char Prefix;

    [PacketField] public CeirinhaPacket Ceirinha;

    [PacketField] public string Name;
    
    [PacketField] public bool IsWorking;
}

public struct CeirinhaPacket : IPacket
{
    [PacketField] public string Ceirinha;
}

Transforming

using System.Text;
using Ceiralizer;
using Ceiralizer.Test;

// Default is UNICODE, change to UTF8 to reduce the size.
PacketSerializer.StringEncoder = Encoding.UTF8;

// Add custom class to serialize
TypeSerializer.Serializers.Add(typeof(Vector2), value =>
{
    List<byte> bytes = new List<byte>();

    Vector2 pos = (Vector2) value;

    byte[] x = TypeSerializer.Serializers[typeof(int)].Invoke(pos.X);
    byte[] y = TypeSerializer.Serializers[typeof(int)].Invoke(pos.Y);

    bytes.AddRange(x);
    bytes.AddRange(y);

    return bytes.ToArray();
});

// And also adding deserializer
TypeSerializer.Deserializers.Add(typeof(Vector2), data =>
{
    int x = data.ReadInt();
    int y = data.ReadInt();

    return new Vector2(x, y);
});

List<byte> data = PacketSerializer.Serialize(new CeiraPacket
{
    Op = 2,
    Value = 255,
    Ceiras = new[] { 4, 66, 95 },
    Garbage = "Lixo",
    Prefix = 'c',
    Ceirinha = new CeirinhaPacket
    {
        Ceirinha = "Ceira purinha"
    },
    Name = "Ceira",
    IsWorking = true,
    Position = new Vector2(5, 25)
}).ToList();

CeiraPacket packet = PacketSerializer.Deserialize<CeiraPacket>(data);

Console.WriteLine(packet.Op);
Console.WriteLine(packet.Value);

foreach (int ceira in packet.Ceiras) Console.Write($" {ceira} ");
Console.WriteLine();

Console.WriteLine(packet.Prefix);
Console.WriteLine(packet.Ceirinha.Ceirinha);
Console.WriteLine(packet.Name);
Console.WriteLine(packet.IsWorking);
Console.WriteLine($"X: {packet.Position.X}, Y: {packet.Position.Y}");

Output

2
255
 4  66  95
c
Ceira purinha
Ceira
True
X: 5, Y: 25

Supported types

• bool - (System.Boolean)
• byte - (System.Byte)
• sbyte - (System.SByte)
• char - (System.Char)
• double - (System.Double)
• float - (System.Single)
• int - (System.Int32)
• uint - (System.UInt32)
• long - (System.Int64)
• ulong - (System.UInt64)
• short - (System.Int16)
• ushort - (System.UInt16)
• string - (System.String)

Implementing Custom Serializers

public class Ceirax : ISerializable
{
    public string Title = "";
    public string Description = "";
    public float Price;

    public byte[] Serialize()
    {
        List<byte> data = new List<byte>();

        data.AddRange(TypeSerializer.Serializers[typeof(string)].Invoke(Title));
        data.AddRange(TypeSerializer.Serializers[typeof(string)].Invoke(Description));
        data.AddRange(TypeSerializer.Serializers[typeof(float)].Invoke(Price));
        
        return data.ToArray();
    }

    public void Deserialize(Chunk data)
    {
        Title = (TypeSerializer.Deserializers[typeof(string)].Invoke(data) as string)!;
        Description = (TypeSerializer.Deserializers[typeof(string)].Invoke(data) as string)!;
        Price = (float) TypeSerializer.Deserializers[typeof(float)].Invoke(data)!;
    }
}

Data Structure

1   | 00000010 00000000                   | 2
2   | 11111111 00000000 00000000 00000000 | 255
3.1 | 00000011 00000000 00000000 00000000 | 3
3.2 | 00000100 00000000 00000000 00000000 | 4
3.2 | 01000010 00000000 00000000 00000000 | 66
3.2 | 01011111 00000000 00000000 00000000 | 95
4   | 01100011                            | 'c'
5.1 | 00001101 00000000 00000000 00000000 | 13
5.2 | 01000011 01100101 01101001 01110010 | "Ceir"
5.2 | 01100001 00100000 01110000 01110101 | "a pu"
5.2 | 01110010 01101001 01101110 01101000 | "rinh"
5.2 | 01100001                            | "a"
6.1 | 00000101 00000000 00000000 00000000 | 5
6.2 | 01000011 01100101 01101001 01110010 | "Ceir"
6.2 | 01100001                            | "a"
7   | 00000001                            | True
8   | 00000101 00000000 00000000 00000000 | 5
8   | 00011001 00000000 00000000 00000000 | 25

01110010 01100001 00000001 000001
01 00000000 00000000 00000000 00011001 00000000 00000000 00000000

*The bytes seem inverted, why the computer reads the list from left to right.

<br/>

1: short 00000000 00000010 | 2

[PacketField] public short Op;

<br/>

*Note that the Garbage has been ignored

2: int 11111111 00000000 00000000 00000000 | 255

[PacketField] public int Value;

<br/>

3: int[]

[PacketField] public int[] Ceiras;

3.1: int 00000011 00000000 00000000 00000000 | 3

*Represents the size of the array

3.2: int[]

00000100 00000000 00000000 00000000 | 4

01000010 00000000 00000000 00000000 | 66

01011111 00000000 00000000 00000000 | 95

*An sequence of integers, the array content

<br/>

4: char 01100011 | 'c'

[PacketField] public char Prefix;

<br/>

5: CeirinhaPacket

[PacketField] public CeirinhaPacket Ceirinha;

*This Packet is merged to main packet

[PacketField] public string Ceirinha;

5.1: int 00001101 00000000 00000000 00000000 | 13

*As strings have no fixed length, an integer comes together to represent their size

5.2: string 01000011 01100101 01101001 01110010 01100001 00100000 01110000 01110101 01110010 01101001 01101110 01101000 01100001 "Ceira purinha"

<br/>

6: serialized string

[PacketField] public string Name;

6.1: int 00000101 00000000 00000000 00000000 | 5

6.2: string 01000011 01100101 01101001 01110010 01100001 | "Ceira"

<br/>

7: bool 00000001 | True

[PacketField] public bool IsWorking;

*Booleans can be 00000000 (False) or 00000001 (True), they represent a byte so as not to interfere with the reading of the packet.

8: Vector2

public struct Vector2
{
    public int X;
    public int Y;

    public Vector2(int x = 0, int y = 0)
    {
        X = x;
        Y = y;
    }
}

// Declaration in the packet
[PacketField] public Vector2 Position;

// Serialization
TypeSerializer.Serializers.Add(typeof(Vector2), value =>
{
    List<byte> bytes = new List<byte>();

    Vector2 pos = (Vector2) value;

    byte[] x = TypeSerializer.Serializers[typeof(int)].Invoke(pos.X);
    byte[] y = TypeSerializer.Serializers[typeof(int)].Invoke(pos.Y);

    bytes.AddRange(x);
    bytes.AddRange(y);

    return bytes.ToArray();
});

// Deserialization
TypeSerializer.Deserializers.Add(typeof(Vector2), data =>
{
    int x = data.ReadInt();
    int y = data.ReadInt();

    return new Vector2(x, y);
});

00000101 00000000 00000000 00000000 | 5

00011001 00000000 00000000 00000000 | 25