metis-lang/io.github.seggan.metis.runtime/CallableValue

CallableValue

interface CallableValue : Value

A Value that can be called.

Inheritors

Instance

OneShotFunction

Types

Executor

interface Executor

An executor for a CallableValue. To help with sandboxing, the executor may take multiple steps to execute the function.

Properties

arity

abstract val arity: Arity

The arity of the function.

metatable

abstract var metatable: Value.Table?

The metatable of this value.

Functions

asObj

inline fun <T> Value.asObj(): T

If this is a Value.Native, returns the native object, otherwise throws an error.

booleanValue

fun Value.booleanValue(): Boolean

Converts this value to a kotlin.Boolean, or throws an error if it cannot be converted.

bytesValue

fun Value.bytesValue(): ByteArray

Converts this value to a Value.Bytes, or throws an error if it cannot be converted.

call

abstract fun call(nargs: Int): CallableValue.Executor

Calls the function with the given number of arguments and creates an executor for it.

convertTo

inline fun <T : Value> Value.convertTo(): T

Converts this value to a T, or throws an error if it cannot be converted.

doubleValue

fun Value.doubleValue(): Double

Converts this value to a Double, or throws an error if it cannot be converted.

intValue

fun Value.intValue(): Int

Converts this value to a Int, or throws an error if it cannot be converted.

listValue

fun Value.listValue(): MutableList<Value>

Converts this value to a Value.List, or throws an error if it cannot be converted.

lookUp

fun Value.lookUp(key: Value): Value?

Look up a value in this value, possibly using the metatable.

lookUpDirect

open fun lookUpDirect(key: Value): Value?

Look up a value in this value.

lookUpHierarchy

fun Value.lookUpHierarchy(vararg keys: String): Value?

Look up a successive sequence of strings in this value.

orNull

fun Value?.orNull(): Value

If this value is null, return Value.Null, otherwise return this value.

set

fun Value.set(key: Value, value: Value): Boolean

Sets a value in this value, possibly using the metatable.

setDirect

open fun setDirect(key: Value, value: Value): Boolean

Set a value in this value.

setOrError

fun Value.setOrError(key: Value, value: Value)

Sets a value in this value, or throws an error if it cannot be set.

stringValue

fun Value.stringValue(): String

Converts this value to a String, or throws an error if it cannot be converted.

tableValue

fun Value.tableValue(): MutableMap<Value, Value>

Converts this value to a Value.Table, or throws an error if it cannot be converted.