https://github.com/Dvergar/PODStream

Haxe POD serializer
https://github.com/Dvergar/PODStream

haxe pod serialization

Last synced: 6 days ago
JSON representation

Haxe POD serializer

• Host: GitHub
• URL: https://github.com/Dvergar/PODStream
• Owner: Dvergar
• Created: 2014-11-30T11:03:03.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-11-01T13:24:06.000Z (about 5 years ago)
• Last Synced: 2024-08-02T07:08:34.211Z (3 months ago)
• Topics: haxe, pod, serialization
• Language: Haxe
• Homepage:
• Size: 26.4 KB
• Stars: 21
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-haxe-gamedev - PODStream - Plain Old Data serializer. (Serialization and storage)

README

        
PODStream

=========

PODStream will serialize and deserialize your fields from/to `BytesInput` / `BytesOutput`.

Given a position class such as:

```Haxe

@:build(podstream.SerializerMacro.build())

class Position

{

    @Short public var x:Float;

    @Short public var y:Float;

    public function new(x:Float, y:Float)

    {

        this.x = x;

        this.y = y;

    }

}

```

You can prefix your fields with:

* `@Short`

* `@UShort`

* `@Int`

* `@Float`

* `@Bool`

* `@Byte`

* `@String`

* `@Int32Array`

* `@Float32Array`

* `@StringArray`

In the example above the haxe macro will generate two methods which will transform your class to:

```Haxe

class Position

{

    public var _id:Int = 0;

    public static var __id:Int = 0;

    public var x:Float;

    public var y:Float;

    public function new(x:Float, y:Float)

    {

        this.x = x;

        this.y = y;

    }

    

    public function unserialize(bi)

    {

        x = bi.readInt16();

        y = bi.readInt16();

    }

    

    public function serialize(bo)

    {

        bo.writeInt16(Std.int(x));

        bo.writeInt16(Std.int(y));

    }

}

```

The library is used in two steps:

* Mark your fields with the appropriate serialization

* Pass your `BytesInput` and `BytesOutput` around

## Redirections

You can redirect deserializations to other variables such as:

`@Short('netx') var x:Float;`

In this case the variable `x` will be serialized as a Short but will be unserialized and assigned to the variable `netx`. It can be helpful when you are sharing the same class between a client & a server.

### Example

```Haxe

@:build(podstream.SerializerMacro.build())

class Position2

{

    @Short("netx") public var x:Float;

    @Short("nety") public var y:Float;

    public var netx:Float;

    public var nety:Float;

    public function new(x:Float, y:Float)

    {

        this.x = x;

        this.y = y;

    }

}

```

will generate:

```Haxe

class Position2

{

    public var _id:Int = 1;

    public static var __id:Int = 1;

    public var x:Float;

    public var y:Float;

    public var netx:Float;

    public var nety:Float;

    public function new(x:Float, y:Float)

    {

        this.x = x;

        this.y = y;

    }

    

    public function unserialize(bi)

    {

        netx = bi.readInt16();

        nety = bi.readInt16();

    }

    

    public function serialize(bo)

    {

        bo.writeInt16(Std.int(x));

        bo.writeInt16(Std.int(y));

    }

}

```

## ID generation

Each class will be assigned a unique public & static ID such as `myInstance._id` and `MyClass.__id`.

## Serialization datas

You can call `podstream.SerializerMacro.getSerialized()` from your application and get an `Array` of the types serialized.

You can then use `Type.resolveClass("YourClassName")` to resolve the type from the string returned if needed.