Enumex.Dynamic.Components.Convert behaviour (Enumex v1.0.0)

View Source

Provides functionality for converting enum schemas to enum values. Implements a standardized interface for converting ecto schemas to Enumex.Value struct.

Dependencies

Requires an Enumex.Dynamic.Components.EctoSchema component.

Usage

defmodule MyApp.MyEnums do
  use Enumex.Dynamic, components: [Enumex.Dynamic.Components.Convert]

  # enum definitions goes here
end

Summary

Callbacks

to_value(schema)

Converts an ecto schema to the Enumex value struct.

Callbacks

to_value(schema)

@callback to_value(Ecto.Schema.schema()) :: Enumex.Value.t()

Converts an ecto schema to the Enumex value struct.

Parameters

  • enum_schema - The ecto schema to convert

Example

%Enumex.Value{} = to_value(enum_schema)