Decree.Store.Serializer behaviour (decree v0.1.0)

Copy Markdown View Source

Specification of a serializer to convert between an Elixir term and its representation in the database.

Summary

Callbacks

Deserialize the given data to the corresponding term.

Whether deserialize/2 can build an event of the given type: false for a type this release does not define, such as one appended by a newer release.

Serialize the given term to a representation that can be stored by the database.

Functions

Get the serializer module from the given config for the event store.

Types

config()

@type config() :: Keyword.t()

t()

@type t() :: module()

Callbacks

deserialize(arg1, config)

@callback deserialize(binary() | map(), config()) :: any()

Deserialize the given data to the corresponding term.

known_type?(type)

(optional)
@callback known_type?(type :: String.t()) :: boolean()

Whether deserialize/2 can build an event of the given type: false for a type this release does not define, such as one appended by a newer release.

Optional. A serializer that does not implement it knows every type. A read that meets an unknown type raises Decree.Store.UnknownEventTypeError, and a subscription holds before the event instead of delivering past it.

serialize(any)

@callback serialize(any()) :: binary() | map()

Serialize the given term to a representation that can be stored by the database.

Functions

serializer(event_store, config)

Get the serializer module from the given config for the event store.