Raxol.Protocols.CoreProtocols.Serializable protocol (Raxol v2.0.1)

Protocol for serializing and deserializing data structures. Handles conversion to/from various formats (JSON, TOML, binary).

Summary

t()

All the types that implement this protocol.

Deserializes data from the specified format.

get_schema(data)

Gets the serialization schema for validation.

Serializes the data to the specified format.

@type t() :: term()

All the types that implement this protocol.

@spec deserialize(
  binary(),
  :json | :toml | :binary | :erlang_term,
  module()
) :: {:ok, t()} | {:error, any()}

Deserializes data from the specified format.

@spec get_schema(t()) :: map()

Gets the serialization schema for validation.

@spec serialize(t(), :json | :toml | :binary | :erlang_term) ::
  {:ok, binary()} | {:error, any()}

Serializes the data to the specified format.