Struct Function

Source

pub struct Function { /* private fields */ }

Expand description

Error reference class

Implementations§

Source §

impl Function

Source

pub fn call_packed(&self, packed_args: &[AnyView<'_>]) -> Result<Any>

Call the function in packed format.

Source

pub fn call_tuple<TupleType>(&self, tuple_args: TupleType) -> Result<Any>
where TupleType: TupleAsPackedArgs,

Source

pub fn call_tuple_with_len<const LEN: usize, TupleType>( &self, tuple_args: TupleType, ) -> Result<Any>
where TupleType: TupleAsPackedArgs,

Call function with compile-time known argument count This is an optimized version of call_tuple for when the argument count is known at compile time, avoiding the small vector optimization overhead.

§Arguments

tuple_args - The tuple arguments

§Returns

Any - The result

Source

pub fn get_global(name: &str) -> Result<Function>

Get global function by name This function will throw an error if the function is not found.

§Arguments

name - The name of the function

§Returns

Function - The global function

Source

pub fn from_type_method(type_index: i32, method_name: &str) -> Result<Function>

Look up a reflected method of a type by type index and method name

Methods registered through the C++ reflection registry (refl::ObjectDef<T>().def(...)) live in the per-type method table rather than the global function table. Constructors registered via refl::init are reachable under the reserved name __ffi_init__. For instance methods, the first packed argument is the object itself.

type_index must be a registered type index (e.g. obtained from a live object via Any::type_index or from a type key); the underlying C API treats an unregistered index as a fatal error.

§Arguments

type_index - The type index of the type that owns the method
method_name - The name of the method

§Returns

Function - The reflected method

Source

pub fn from_type_attr(type_index: i32, attr_name: &str) -> Result<Function>

Look up a function-valued attribute for a concrete runtime type.

Type attributes are not inherited from base types.

Source

pub fn from_type_key_method( type_key: &str, method_name: &str, ) -> Result<Function>

Look up a reflected method of a type by type key and method name

Same as Function::from_type_method, but resolves type_key to a type index first.

§Arguments

type_key - The type key of the type that owns the method
method_name - The name of the method

§Returns

Function - The reflected method

Source

pub fn register_global(name: &str, func: Function) -> Result<()>

Register a function as a global function

§Arguments

name - The name of the function
func - The function to register

§Returns

Result<()> - The result of the registration

Source

pub fn from_packed<F>(func: F) -> Self
where F: Fn(&[AnyView<'_>]) -> Result<Any> + 'static,

Construct a function from a packed function

§Arguments

func - The packed function in signature of Fn(&[AnyView]) -> Result<Any>

§Returns

Function - The function

Source

pub fn from_typed<F, I, O>(func: F) -> Self
where F: AsPackedCallable<I, O> + 'static,

Construct a function from a typed function

§Arguments

func - The typed function with function signature of F(T0, T1, ...) -> Result<O>

§Returns

Function - The function

Source

pub unsafe fn from_extern_c( handle: mut c_void, safe_call: TVMFFISafeCallType, deleter: Option<unsafe extern "C" fn(mut c_void)>, ) -> Self

§Safety

handle must be a valid pointer (or null) that is compatible with safe_call and deleter. The caller must ensure the handle outlives the returned Function (or that deleter properly frees it).