Packages
ecto
2.0.0-beta.1
3.14.1
3.14.0
3.13.6
3.13.5
3.13.4
3.13.3
3.13.2
3.13.1
3.13.0
3.12.6
3.12.5
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.11.2
3.11.1
3.11.0
3.10.3
3.10.2
3.10.1
3.10.0
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.9.0
3.8.4
3.8.3
3.8.2
3.8.1
3.8.0
3.7.2
3.7.1
3.7.0
3.6.2
3.6.1
3.6.0
3.5.8
3.5.7
3.5.6
3.5.5
3.5.4
3.5.3
3.5.2
3.5.1
3.5.0
3.5.0-rc.1
3.5.0-rc.0
3.4.6
3.4.5
3.4.4
3.4.3
3.4.2
3.4.1
3.4.0
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.5
3.2.4
3.2.3
3.2.2
3.2.1
3.2.0
3.1.7
3.1.6
3.1.5
3.1.4
3.1.3
3.1.2
3.1.1
3.1.0
3.0.9
3.0.8
3.0.7
3.0.6
3.0.5
3.0.4
3.0.3
3.0.2
3.0.1
3.0.0
3.0.0-rc.1
3.0.0-rc.0
2.2.12
2.2.11
2.2.10
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.2.0-rc.1
2.2.0-rc.0
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.1.0-rc.5
2.1.0-rc.4
2.1.0-rc.3
2.1.0-rc.2
2.1.0-rc.1
2.1.0-rc.0
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
2.0.0-rc.6
2.0.0-rc.5
2.0.0-rc.4
2.0.0-rc.3
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
2.0.0-beta.2
2.0.0-beta.1
2.0.0-beta.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.16.0
0.15.0
0.14.3
0.14.2
0.14.1
0.14.0
0.13.1
0.13.0
0.12.1
0.12.0
0.12.0-rc
0.11.3
0.11.2
0.11.1
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.9.0
0.8.1
0.8.0
0.7.2
0.7.1
0.7.0
0.6.0
0.5.1
0.5.0
0.4.0
0.3.0
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
A toolkit for data mapping and language integrated query for Elixir
Current section
Files
Jump to
Current section
Files
lib/ecto/data_type.ex
defprotocol Ecto.DataType do
@moduledoc """
Casts a given data type into an `Ecto.Type`.
While `Ecto.Type` allows developers to cast/load/dump
any value from the storage into the struct based on the
schema, `Ecto.DataType` allows developers to convert
existing data types into existing Ecto types, be them
primitive or custom.
For example, `Ecto.Date` is a custom type, represented
by the `%Ecto.Date{}` struct that can be used in place
of Ecto's primitive `:date` type. Therefore, we need to
tell Ecto how to convert `%Ecto.Date{}` into `:date` and
such is done with the `Ecto.DataType` protocol:
defimpl Ecto.DataType, for: Ecto.Date do
# Dumps to the default representation. In this case, :date.
def dump(value) do
cast(value, :date)
end
# Implement any other desired casting rule.
def cast(%Ecto.Date{day: day, month: month, year: year}, :date) do
{:ok, {year, month, day}}
end
def cast(_, _) do
:error
end
end
"""
@fallback_to_any true
@spec dump(term) :: {:ok, term} | :error
def dump(value)
@spec cast(term, Ecto.Type.t) :: {:ok, term} | :error
def cast(value, type)
end
defimpl Ecto.DataType, for: Any do
# We don't provide any automatic casting rule.
def cast(_value, _type) do
:error
end
# The default representation is itself.
def dump(value) do
{:ok, value}
end
end
defimpl Ecto.DataType, for: Ecto.Query.Tagged do
def dump(%{value: value}), do: {:ok, value}
def cast(%{}, _type), do: :error
end
defimpl Ecto.DataType, for: Ecto.DateTime do
def dump(value), do: cast(value, :datetime)
def cast(%Ecto.DateTime{year: year, month: month, day: day,
hour: hour, min: min, sec: sec, usec: usec}, :datetime) do
{:ok, {{year, month, day}, {hour, min, sec, usec}}}
end
def cast(_, _) do
:error
end
end
defimpl Ecto.DataType, for: Ecto.Date do
def dump(value), do: cast(value, :date)
def cast(%Ecto.Date{year: year, month: month, day: day}, :date) do
{:ok, {year, month, day}}
end
def cast(_, _) do
:error
end
end
defimpl Ecto.DataType, for: Ecto.Time do
def dump(value), do: cast(value, :time)
def cast(%Ecto.Time{hour: hour, min: min, sec: sec, usec: usec}, :time) do
{:ok, {hour, min, sec, usec}}
end
def cast(_, _) do
:error
end
end