Struct SquirrelFn 

pub struct SquirrelFn<'a, T: IntoSquirrelArgs> { /* private fields */ }

provides invariance for calling squirrel functions with little overhead

Implementations

impl<'a, T: IntoSquirrelArgs> SquirrelFn<'a, T>

pub const unsafe fn new_unchecked(obj: SQHandle<'a, SQClosure>) -> Self

creates a new SquirrelFn using the invariance of SQHandle<SQClosure>

Safety

doesn’t check if the function passed has the correct args and return type

pub fn run( &mut self, sqvm: NonNull<HSquirrelVM>, sqfunctions: &'static SquirrelFunctions, args: T, ) -> Result<(), CallError>

calls the underlying squirrel function on the provided sqvm

Errors

This function will return an error if the fails to execute for some reason which is unlikely since it would be type checked

pub fn call( &mut self, sqvm: NonNull<HSquirrelVM>, sqfunctions: &'static SquirrelFunctions, args: T, ) -> Result<(), CallError>

calls the underlying squirrel function on the provided sqvm

Errors

This function will return an error if the fails to execute for some reason which is unlikely since it would be type checked

Trait Implementations

impl<'a, T: IntoSquirrelArgs> AsRef<SQHandle<'a, SQClosure>> for SquirrelFn<'a, T>

fn as_ref(&self) -> &SQHandle<'a, SQClosure>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: IntoSquirrelArgs> GetFromSQObject for SquirrelFn<'_, T>

fn get_from_sqobject(obj: &SQObject) -> Self

gets the value out of a sqobject

impl<T: IntoSquirrelArgs> GetFromSquirrelVm for SquirrelFn<'_, T>

fn get_from_sqvm( sqvm: NonNull<HSquirrelVM>, sqfunctions: &'static SquirrelFunctions, stack_pos: i32, ) -> Self

tries to get the value out of the squirrel stack but it cannot fail so this can panic

impl<T: SQVMName + IntoSquirrelArgs> SQVMName for SquirrelFn<'_, T>

fn get_sqvm_name() -> String

the name on the sqvm of a type