Use this module to generate the Elixir structs corresponding to a set of protobuf definitions and to encode/decode instances of these structures.

Elixit structs generation examples

From a set of files:

defmodule Dummy do
  use Protox,
    files: [
      "./defs/foo.proto",
      "./defs/bar.proto",
      "./defs/baz/fiz.proto",
    ]
end

From a string:

defmodule Dummy do
  use Protox,
    schema: """
    syntax = "proto3";
    package fiz;

    message Baz {
    }

    message Foo {
      map<int32, Baz> b = 2;
    }
    """
end

The generated modules respect the package declaration. For instance, in the above example, both the Fiz.Baz and Fiz.Foo modules will be generated.

Encoding/decoding

For the rest of this module documentation, we suppose the following protobuf messages are defined:

defmodule Dummy do
  use Protox,
    schema: """
      syntax = "proto3";
      package fiz;

      message Baz {
      }

      enum Enum {
        FOO = 0;
        BAR = 1;
      }

      message Foo {
        Enum a = 1;
        map<int32, Baz> b = 2;
      }
    """,
    namespace: Namespace

  use Protox,
    schema: """
    syntax = "proto3";

    message Msg {
      map<int32, string> msg_k = 8;
    }
    """

  use Protox,
    schema: """
    syntax = "proto3";

    message Sub {
      int32 a = 1;
    }
    """
end

See each function documentation to see how they are used to encode and decode protobuf messages.