Ecto DateTimeRange
v1.2.2

View Source Ecto.DateTimeRange.Time (Ecto DateTimeRange v1.2.2)

An Ecto.Type wrapping a :tsrange Postgres column. To the application, it appears as a struct with :start_at and :end_at, with t:Time.t() values.

This type does not do any time zone conversions--times going in will be times coming out.

defmodule Core.Thing do
  use Ecto.Schema
  import Ecto.Changeset

  schema "things" do
    field :performed_during, Ecto.DateTimeRange.Time
  end

  @required_attrs ~w[performed_during]a
  def changeset(data \ %__MODULE__{}, attrs) do
    data
    |> cast(attrs, @required_attrs)
    |> validate_required(@required_attrs)
  end
end

Link to this section Summary

Types

t()

Ecto.Type Callbacks

cast(arg1)

Converts user-provided data (for example from a form) to the Elixir term.

dump(arg1)

Converts the Elixir term to the Ecto native type.

embed_as(_)

Declares than when used in embedded schemas, the type will be dumped before being encoded.

equal?(first, second)

Checks if two terms are equal.

load(arg1)

Converts the Ecto native type to the Elixir term.

type()

Declares the native type that will be used in the database.

Functions

contains?(range, time)

Returns true or false depending on whether the time is falls within the specified range. Note: this assumes that the range is in the same time zone as whatever time or date time it is compared against.

parse(string)

Create an Ecto.DateTimeRange.Time from two ISO8601 strings.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Ecto.DateTimeRange.Time{end_at: Time.t(), start_at: Time.t()}

Link to this section Ecto.Type Callbacks

Link to this function

cast(arg1)

View Source

Converts user-provided data (for example from a form) to the Elixir term.

Link to this function

dump(arg1)

View Source

Converts the Elixir term to the Ecto native type.

Link to this function

embed_as(_)

View Source

Declares than when used in embedded schemas, the type will be dumped before being encoded.

Link to this function

equal?(first, second)

View Source

Checks if two terms are equal.

Link to this function

load(arg1)

View Source

Converts the Ecto native type to the Elixir term.

Link to this function

type()

View Source

Declares the native type that will be used in the database.

Link to this section Functions

Link to this function

contains?(range, time)

View Source 
@spec contains?(t(), DateTime.t() | NaiveDateTime.t() | Time.t()) :: boolean()

Returns true or false depending on whether the time is falls within the specified range. Note: this assumes that the range is in the same time zone as whatever time or date time it is compared against.

example

 Example 

iex> import Ecto.DateTimeRange
...>
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~T[00:00:00])
false
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~T[01:00:00])
true
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~T[01:59:59])
true
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~T[02:00:00])
false
...>
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~N[2022-01-01T00:00:00])
false
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~N[2022-01-01T01:00:00])
true
...>
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~U[2022-01-01T00:00:00Z])
false
iex> Ecto.DateTimeRange.Time.contains?(~t[01:00:00..02:00:00]T, ~U[2022-01-01T01:00:00Z])
true
Link to this function

parse(string)

View Source 
@spec parse(binary()) :: {:ok, t()} | {:error, term()}

Create an Ecto.DateTimeRange.Time from two ISO8601 strings.

example

 Example 

iex> Ecto.DateTimeRange.Time.parse("00:01:00..00:01:01")
{:ok, %Ecto.DateTimeRange.Time{start_at: ~T[00:01:00], end_at: ~T[00:01:01]}}

iex> Ecto.DateTimeRange.Time.parse("00:01:00..later")
{:error, "Unable to parse Time(s) from input"}