Ecto v3.5.0-rc.0 Ecto.Enum View Source
A custom type that maps atoms to strings.
Ecto.Enum
must be used whenever you want to keep atom values in a field.
Since atoms cannot be persisted to the database, Ecto.Enum
converts them
to string when writing to the database and converts them back to atoms when
loading data. It can be used in your schemas as follows:
field :status, Ecto.Enum, values: [:foo, :bar, :baz]
:values
must be a list of atoms. String values will be cast to atoms safely
and only if the atom exists in the list (otherwise an error will be raised).
Attempting to load any string not represented by an atom in the list will be
invalid.
Link to this section Summary
Functions
Callback implementation for Ecto.ParameterizedType.cast/2
.
Callback implementation for Ecto.ParameterizedType.dump/3
.
Callback implementation for Ecto.ParameterizedType.embed_as/2
.
Callback implementation for Ecto.ParameterizedType.equal?/3
.
Callback implementation for Ecto.ParameterizedType.init/1
.
Callback implementation for Ecto.ParameterizedType.load/3
.
Callback implementation for Ecto.ParameterizedType.type/1
.
Link to this section Functions
Callback implementation for Ecto.ParameterizedType.cast/2
.
Callback implementation for Ecto.ParameterizedType.dump/3
.
Callback implementation for Ecto.ParameterizedType.embed_as/2
.
Callback implementation for Ecto.ParameterizedType.equal?/3
.
Callback implementation for Ecto.ParameterizedType.init/1
.
Callback implementation for Ecto.ParameterizedType.load/3
.
Callback implementation for Ecto.ParameterizedType.type/1
.