quarkdown-core/com.quarkdown.core.function/Function

Function

interface Function<T : OutputValue<*>>

A function that can be called from a Quarkdown source via a FunctionCall.

Parameters

expected output type

Inheritors

SimpleFunction

KFunctionAdapter

Properties

invoke

abstract val invoke: (ArgumentBindings) -> T

Function that maps the input arguments into an output value. Arguments and parameters compliance in terms of matching types and count is not checked here. The ArgumentBindings allow looking up argument values by their parameter.

name

abstract val name: String

Function name.

parameters

abstract val parameters: List<FunctionParameter<*>>

Declared parameters.

validators

abstract val validators: List<FunctionCallValidator<T>>

Validators that check the validity of a function call towards this function. If a condition is not met during the validation, an exception should be thrown.

Functions

signatureAsString

fun Function<*>.signatureAsString(includeName: Boolean = true): String