View Source Crontab.CronExpression.Ecto.Type (crontab v1.1.14)

Provides a type for Ecto usage.

The underlying data type should be a map.

Migration Example

create table(:my_table) do
  add :schedule, :map
end

Schema Example

schema "my_table" do
  field :schedule, Crontab.CronExpression.Ecto.Type
end

Summary

Types

map_expression()

Functions

cast(cron_expression)

Callback implementation for Ecto.Type.cast/1.

dump(cron_expression)

Callback implementation for Ecto.Type.dump/1.

embed_as(_)

Callback implementation for Ecto.Type.embed_as/1.

equal?(term1, term2)

Callback implementation for Ecto.Type.equal?/2.

load(arg1)

Callback implementation for Ecto.Type.load/1.

type()

Callback implementation for Ecto.Type.type/0.

Types

map_expression()

@type map_expression() :: %{
  extended: boolean(),
  reboot: boolean(),
  second: [Crontab.CronExpression.value(Calendar.second())],
  minute: [Crontab.CronExpression.value(Calendar.minute())],
  hour: [Crontab.CronExpression.value(Calendar.second())],
  day: [Crontab.CronExpression.value(Calendar.day())],
  month: [Crontab.CronExpression.value(Calendar.month())],
  weekday: [Crontab.CronExpression.value(Calendar.day_of_week())],
  year: [Crontab.CronExpression.value(Calendar.year())]
}

Functions

cast(cron_expression)

@spec cast(any()) :: {:ok, Crontab.CronExpression.t()} | :error

Callback implementation for Ecto.Type.cast/1.

dump(cron_expression)

@spec dump(any()) :: {:ok, Crontab.CronExpression.t()} | :error

Callback implementation for Ecto.Type.dump/1.

embed_as(_)

Callback implementation for Ecto.Type.embed_as/1.

equal?(term1, term2)

Callback implementation for Ecto.Type.equal?/2.

load(arg1)

@spec load(any()) :: {:ok, Crontab.CronExpression.t()} | :error

Callback implementation for Ecto.Type.load/1.

type()

@spec type() :: :map

Callback implementation for Ecto.Type.type/0.