View Source Protobuf.TransformModule behaviour (protobuf v0.13.0)

Behaviour for transformer modules.

By defining a transform_module/0 function on your protobuf message module you can add custom encoding and decoding logic for your message.

The Protobuf.new/1 function will not be called for structs that have a transform module, if you still want to emulate this behavior you can use Protobuf.TransformModule.InferFieldsFromEnum.

As an example we can use this to implement a message that will be decoded as a string value:

defmodule StringMessage do
  use Protobuf, syntax: :proto3

  defstruct [:value]

  field :value, 1, type: :string

  def transform_module(), do: MyTransformModule
end

The transformer behaviour implementation:

defmodule MyTransformModule do
  @behaviour Protobuf.TransformModule

  @impl true
  def encode(string, StringMessage) when is_binary(string), do: %StringMessage{value: string}

  @impl true
  def decode(%StringMessage{value: string}, StringMessage), do: string
end

Summary

Callbacks

Takes any protobuf message and the message type and encodes it into arbitrary Elixir term.

Takes any Elixir term and the protobuf message type and encodes it into that type.

Types

@type message() :: struct()
@type type() :: module()
@type value() :: term()

Callbacks

@callback decode(message(), type()) :: value()

Takes any protobuf message and the message type and encodes it into arbitrary Elixir term.

Called after a message is decoded.

@callback encode(value(), type()) :: message()

Takes any Elixir term and the protobuf message type and encodes it into that type.

Called before a message is encoded.