Struct Function 

pub struct Function { /* private fields */ }

A callable unit: a signature plus a body.

See the module docs.

Implementations

impl Function

pub fn new(signature: FunctionSignature, body: FunctionBody) -> Self

Pairs a signature with a body.

pub fn signature(&self) -> &FunctionSignature

Returns the signature.

pub fn invoke(&self, context: &mut Context, registry: &Registry)

Runs the function on data already on the stack.

Arguments must be pushed in reverse order beforehand, and results are left on the stack. Registers are scoped around the body, so the callee cannot reach the caller’s.

pub fn call<O: DataStackPack, I: DataStackPack>( &self, context: &mut Context, registry: &Registry, inputs: I, verify: bool, ) -> O

Runs the function with Rust values, taking care of stack order.

With verify set, argument and result types are checked against the signature first.

Panics

Panics when verify is set and the types do not match, or when the results on the stack are not of type O.

pub fn verify_inputs_outputs<O: DataStackPack, I: DataStackPack>(&self)

Checks that I and O match the signature.

Panics

Panics with a message naming the offending parameter when they do not.

pub fn into_handle(self) -> FunctionHandle

Wraps this function in a shared handle.

Trait Implementations

impl Debug for Function

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.