View Source Ash.Query.Function behaviour (ash v2.15.0)

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.

Summary

arg()

args()

The number and types of arguments supported.

evaluate(func)

new(list)

private?()

new(mod, args)

ordinal(num)

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

@type arg() :: any()

@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()}

(optional)

@callback partial_evaluate(func) :: func when func: map()

@callback private?() :: boolean()