View Source Ash.Query.Function behaviour (ash v1.53.3)

A function is a predicate with an arguments list.

For more information on being a predicate, see Ash.Filter.Predicate. Most of the complexities are there. A function must meet both behaviours.

Link to this section Summary

Callbacks

The number and types of arguments supported.

Functions

Attaches the appropiate suffix to refer to an ordinal number, e.g 1 -> "1st"

Link to this section Types

Link to this section Callbacks

@callback args() :: [arg()]

The number and types of arguments supported.

@callback evaluate(func :: map()) :: :unknown | {:known, term()}
@callback new([term()]) :: {:ok, term()} | {:error, String.t() | Exception.t()}

Link to this section Functions

Attaches the appropiate suffix to refer to an ordinal number, e.g 1 -> "1st"