croma v0.6.7 Croma.SubtypeOfAtom View Source

Helper module to define type whose members are a fixed set of atoms. The following members are generated by use Croma.SubtypeOfAtom:

  • @type t
  • @spec validate(term) :: Croma.Result.t(t)

Options:

  • :values - List of atoms of possible values.
  • :default - Default value for this type. Passing this option generates default/0.

Examples

defmodule MyAtom do
  use Croma.SubtypeOfAtom, values: [:foo, :bar, :baz], default: :foo
end