View Source Ash.Query.Function behaviour (ash v3.0.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)

If true, will be allowed to evaluate nil inputs.

name()

new(list)

predicate?()

private?()

evaluate(func)

Evaluate the operator with provided inputs

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()] | :var_args

The number and types of arguments supported.

@callback eager_evaluate?() :: boolean()

@callback evaluate(func :: map()) :: :unknown | {:known, term()} | {:error, term()}

@callback evaluate_nil_inputs?() :: boolean()

If true, will be allowed to evaluate nil inputs.

If false (the default), any nil inputs will cause a nil return.

@callback name() :: atom()

@callback new([term()]) :: {:ok, term()} | {:error, String.t() | Exception.t()}

(optional)

@callback partial_evaluate(func) :: {:ok, func} | {:error, term()} when func: map()

@callback predicate?() :: boolean()

@callback private?() :: boolean()