Fact.Seam.Encoder behaviour (Fact v0.2.1)

Behaviour defining how to encode records before they are written to storage.

Implementations of this seam provide the logic for transforming a record into a binary or iodata format suitable for persistence.

Callback

encode/3 – Encodes the given record using the seam instance. Accepts optional parameters via opts. Returns {:ok, iodata()} on success or {:error, reason} on failure.

t()

family()

id()

init(map)

option_specs()

version()

@type t() :: struct()

@callback default_options() :: map()

@callback encode(t(), term(), keyword()) :: {:ok, iodata()} | {:error, term()}

@callback family() :: atom()

@callback id() :: {atom(), non_neg_integer()}

@callback init(map()) :: struct() | {:error, term()}

@callback normalize_options(map()) :: {:ok, map()} | {:error, term()}

@callback option_specs() :: %{required(atom()) => map()}

@callback prepare_options(map()) :: map()

@callback version() :: non_neg_integer()