# acrostic

[![Package Version](https://img.shields.io/hexpm/v/acrostic)](https://hex.pm/packages/acrostic)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/acrostic/)

A pure Gleam implementation of Google Protobuf.


## Note:

1. only support proto3
2. only support enum, message, repeated
3. each message must have an annotation before it start

    `// @gleam record` is mean a embedded struct (record)

    `// @gleam msgid = 1` is mean a api, msgid is a big-end 2 bytes number (max is 65535)

4. when you generated the `game.gleam`, the `game.encode(msg)` or `game.decode(binary)` all Assuming that the msgid is packaged in the head of binary (This will help with communication between the client and server)
5. see `game.proto`



## Useage:
1. use `acrostic.gen` gen gleam file (eg: `src/game.gleam`) from proto files

```sh
gleam add acrostic
```
```gleam
import acrostic

pub fn main() {
  acrostic.gen(["game.proto"], to: "src/game.gleam", flags: acrostic.Flags(False, False))
}
```

2. test encode/decode
```gleam
import game

let binary = game.encode(
    game.Test(
      hello: "hi",
      world: 1.0,
      item: game.Item(id:1, num:1),
      pet: game.Cat,
      nums: []
    )
  )

let assert Ok(test_msg) = game.decode(binary)

```

Further documentation can be found at <https://hexdocs.pm/acrostic>.

## Development

```sh
gleam test  # Run the tests
```