Avrora.Codec behaviour (avrora v0.23.0) View Source

A behaviour for encoding/decoding Avro messages.

Link to this section Summary

Callbacks

Decode a binary Avro message into the Elixir data.

Decode a binary Avro message into the Elixir data with given schema.

Encode the Elixir data into a binary Avro message.

Extract schema from the binary Avro message.

Check either a given binary Avro message is decodable with a specific codec or not.

Link to this section Callbacks

Specs

decode(payloadd :: binary()) ::
  {:ok, result :: map() | [map()]} | {:error, reason :: term()}

Decode a binary Avro message into the Elixir data.

Examples

...> payload = <<0, 0, 0, 0, 8, 72, 48, 48, 48, 48, 48, 48, 48, 48, 45,
48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48,
48, 48, 48, 48, 48, 48, 48, 48, 48, 123, 20, 174, 71, 225, 250, 47, 64>>
...> Avrora.Codec.SchemaRegistry.decode(payload)
{:ok, %{"id" => "00000000-0000-0000-0000-000000000000", "amount" => 15.99}}
Link to this callback

decode(payload, options)

View Source

Specs

decode(payload :: binary(), options :: keyword(Avrora.Schema.t())) ::
  {:ok, result :: map() | [map()]} | {:error, reason :: term()}

Decode a binary Avro message into the Elixir data with given schema.

Examples

...> payload = <<72, 48, 48, 48, 48, 48, 48, 48, 48, 45, 48, 48, 48, 48,
45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 48, 48, 48,
48, 48, 48, 48, 48, 123, 20, 174, 71, 225, 250, 47, 64>>
...> {:ok, schema} = Avrora.Resolver.resolve("io.confluent.Payment")
...> Avrora.Codec.Plain.decode(payload, schema: schema)
{:ok, %{"id" => "00000000-0000-0000-0000-000000000000", "amount" => 15.99}}
Link to this callback

encode(payload, options)

View Source

Specs

encode(payload :: binary() | map(), options :: keyword(Avrora.Schema.t())) ::
  {:ok, result :: binary()} | {:error, reason :: term()}

Encode the Elixir data into a binary Avro message.

Examples

...> payload = %{"id" => "00000000-0000-0000-0000-000000000000", "amount" => 15.99}
...> {:ok, schema} = Avrora.Resolver.resolve("io.confluent.Payment")
...> Avrora.Codec.Plain.encode(payload, schema: schema)
<<72, 48, 48, 48, 48, 48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48,
48, 45, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 123, 20, 174, 71, 225, 250, 47, 64>>

Specs

extract_schema(payload :: binary()) ::
  {:ok, result :: Avrora.Schema.t()} | {:error, reason :: term()}

Extract schema from the binary Avro message.

Examples

...> payload = <<0, 0, 0, 0, 42, 72, 48, 48, 48, 48, 48, 48, 48, 48, 45, 48,
48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 45, 48, 48, 48, 48, 48,
48, 48, 48, 48, 48, 48, 48, 123, 20, 174, 71, 225, 250, 47, 64>>
...> {:ok, schema} = Avrora.Codec.SchemaRegistry.extract_schema(payload)
...> schema.id
42
...> schema.full_name
"io.confluent.Payment"

Specs

is_decodable(payload :: binary()) :: boolean()

Check either a given binary Avro message is decodable with a specific codec or not.

NOTE: It's not guaranteed that a decodable binary message will be successfuly decoded.

Examples

...> Avrora.Codec.Plain.is_decodable(<<1, 2, 3>>)
true
...> Avrora.Codec.SchemaRegistry.is_decodable(<<1, 2, 3>>)
false