ash v1.34.7 Ash.Type behaviour View Source
This behaviour is a superset of the Ecto.Type behavior, that also contains api level information, like what kinds of filters are allowed.
Much better to use Ash.Type than to say @behaviour Ash.Type and define
everything yourself.
Overriding the {:array, type} behavior. By definining the *_array versions
of cast_input, cast_stored, dump_to_native and apply_constraints, you can
override how your type behaves as a collection. This is how the features of embedded
resources are implemented. No need to implement them unless you wish to override the
default behavior.
Built in types
:map-Ash.Type.Map:term-Ash.Type.Term:atom-Ash.Type.Atom:string-Ash.Type.String:integer-Ash.Type.Integer:interval-Ash.Type.Interval:function-Ash.Type.Function:boolean-Ash.Type.Boolean:uuid-Ash.Type.UUID:binary-Ash.Type.Binary:date-Ash.Type.Date:decimal-Ash.Type.Decimal:ci_string-Ash.Type.CiString:utc_datetime-Ash.Type.UtcDatetime:utc_datetime_usec-Ash.Type.UtcDatetimeUsec:url_encoded_binary-Ash.Type.UrlEncodedBinary
Composite Types
Currently, the only composite type supported is a list type, specified via:
{:array, Type}. The constraints available are:
:items- Constraints for the elements of the list. See the contained type's docs for more.:min_length- A minimum length for the items:max_length- A maximum length for the items:nil_items?- Whether or not the list can contain nil items The default value istrue.
Link to this section Summary
Functions
Confirms if a casted value matches the provided constraints.
Returns true if the value is a builtin type or adopts the Ash.Type behaviour
Casts input (e.g. unknown) data to an instance of the type, or errors
Casts a value from the data store to an instance of the type, or errors
Casts a value from the Elixir type to a value that the data store can persist
Returns the ecto compatible type for an Ash.Type.
Determines if two values of a given type are equal.
Process the old casted values alongside the new casted values.
Process the old casted values alongside the new uncasted values.
Returns the underlying storage type (the underlying type of the ecto type of the ash type)
Link to this section Types
Link to this section Functions
Specs
apply_constraints(t(), term(), constraints()) :: {:ok, term()} | {:error, String.t()}
Confirms if a casted value matches the provided constraints.
Specs
Returns true if the value is a builtin type or adopts the Ash.Type behaviour
Specs
cast_input(t(), term(), constraints() | nil) :: {:ok, term()} | {:error, Keyword.t()} | :error
Casts input (e.g. unknown) data to an instance of the type, or errors
Maps to Ecto.Type.cast/2
Specs
cast_stored(t(), term(), constraints() | nil) :: {:ok, term()} | {:error, keyword()} | :error
Casts a value from the data store to an instance of the type, or errors
Maps to Ecto.Type.load/2
Specs
constraints(t()) :: constraints()
Specs
dump_to_native(t(), term(), constraints() | nil) :: {:ok, term()} | {:error, keyword()} | :error
Casts a value from the Elixir type to a value that the data store can persist
Maps to Ecto.Type.dump/2
Specs
ecto_type(t()) :: Ecto.Type.t()
Returns the ecto compatible type for an Ash.Type.
If you use Ash.Type, this is created for you. For builtin types
this may return a corresponding ecto builtin type (atom)
Specs
Determines if two values of a given type are equal.
Maps to Ecto.Type.equal?/3
Specs
Process the old casted values alongside the new casted values.
This is leveraged by embedded types to know if something is being updated or destroyed. This is not called on creates.
Process the old casted values alongside the new uncasted values.
This is leveraged by embedded types to know if something is being updated or destroyed. This is not called on creates.
Specs
storage_type(t()) :: Ecto.Type.t()
Returns the underlying storage type (the underlying type of the ecto type of the ash type)
Link to this section Callbacks
Specs
apply_constraints(term(), constraints()) :: {:ok, new_value :: term()} | :ok | {:error, constraint_error() | [constraint_error()]}
Specs
apply_constraints_array([term()], constraints()) :: {:ok, new_values :: [term()]} | :ok | {:error, constraint_error() | [constraint_error()]}
Specs
array_constraints() :: constraints()
Specs
cast_input(term(), constraints()) :: {:ok, term()} | {:error, Keyword.t()} | :error
Specs
cast_input_array([term()], constraints()) :: {:ok, [term()]} | {:error, Keyword.t()} | :error
Specs
cast_stored(term(), constraints()) :: {:ok, term()} | :error
Specs
cast_stored_array([term()], constraints()) :: {:ok, [term()]} | :error
Specs
constraints() :: constraints()
Specs
describe(constraints()) :: String.t() | nil
Specs
dump_to_native(term(), constraints()) :: {:ok, term()} | :error
Specs
dump_to_native_array([term()], constraints()) :: {:ok, term()} | :error
Specs
ecto_type() :: Ecto.Type.t()
Specs
Specs
handle_change(old_term :: term(), new_term :: term(), constraints()) :: {:ok, term()} | {:error, term()}
Specs
handle_change_array(old_term :: [term()], new_term :: [term()], constraints()) :: {:ok, term()} | {:error, term()}
Specs
prepare_change(old_term :: term(), new_uncasted_term :: term(), constraints()) :: {:ok, term()} | {:error, term()}
prepare_change_array(old_term, new_uncasted_term, constraints)
View Source (optional)Specs
prepare_change_array( old_term :: [term()], new_uncasted_term :: [term()], constraints() ) :: {:ok, term()} | {:error, term()}
Specs
storage_type() :: Ecto.Type.t()