ash v0.1.3 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. Eventually, this may be used for composite types or serialization.
Much better to use Ash.Type
than to say @behaviour Ash.Type
and define
everything yourself.
Link to this section Summary
Functions
Returns true if the value is a builtin type or adopts the Ash.Type
behaviour
A list of the built in type names
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.
Determines whether or not this value can be sorted.
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
Returns true if the value is a builtin type or adopts the Ash.Type
behaviour
A list of the built in type names
Casts input (e.g. unknown) data to an instance of the type, or errors
Maps to Ecto.Type.cast/2
Casts a value from the data store to an instance of the type, or errors
Maps to Ecto.Type.load/2
Casts a value from the Elixir type to a value that the data store can persist
Maps to Ecto.Type.dump/2
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)
Determines if two values of a given type are equal.
Maps to Ecto.Type.equal?/3
sortable?(type, data_layer)
View Sourcesortable?(t(), Ash.data_layer()) :: boolean()
Determines whether or not this value can be sorted.
Returns the underlying storage type (the underlying type of the ecto type of the ash type)
supports_filter?(resource, type, filter_type, data_layer)
View Sourcesupports_filter?( Ash.resource(), t(), Ash.DataLayer.filter_type(), Ash.data_layer() ) :: boolean()
Link to this section Callbacks
supported_filter_types(arg1)
View Sourcesupported_filter_types(Ash.data_layer()) :: [Ash.Actions.Filter.filter_type()]