Struct Module

#[repr(C)]
pub struct Module { /* private fields */ }

ABI-stable owned Module for FFI operations.

Implementations

impl Module

pub fn load_from_file<Str: AsRef<str>>(file_name: Str) -> Result<Module>

Load a module from a dynamic library file.

Arguments

• file_name - Path to the dynamic library file to load

Returns

• Result<Module> - A Module instance on success

pub fn get_function<Str: AsRef<str>>(&self, name: Str) -> Result<Function>

Get a function from the module by name.

Arguments

• name - The name of the function to retrieve

Returns

• Result<Function> - A Function instance on success

pub fn implements_function<Str: AsRef<str>>( &self, name: Str, query_imports: bool, ) -> Result<bool>

Check whether the module implements a function.

Arguments

• name - The name of the function
• query_imports - Whether to also check the modules this module imports

Returns

• Result<bool> - Whether the function exists

pub fn get_function_metadata<Str: AsRef<str>>( &self, name: Str, query_imports: bool, ) -> Result<Option<String>>

Get the metadata of a function the module exports.

The metadata is a JSON object whose type_schema entry is the function’s type schema, as C++ TVM_FFI_DLL_EXPORT_TYPED_FUNC exports it with TVM_FFI_DLL_EXPORT_INCLUDE_METADATA.

Arguments

• name - The name of the function
• query_imports - Whether to also check the modules this module imports

Returns

• Result<Option<String>> - The metadata as a JSON string, or None if the function has no metadata

pub fn get_function_doc<Str: AsRef<str>>( &self, name: Str, query_imports: bool, ) -> Result<Option<String>>

Get the doc string of a function the module exports.

The doc string is the one C++ TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC exports.

Arguments

• name - The name of the function
• query_imports - Whether to also check the modules this module imports

Returns

• Result<Option<String>> - The doc string, or None if the function has none

Trait Implementations

impl AnyCompatible for Module

unsafe fn is_undefined(field: *const Self) -> bool

Whether field, which holds a value of this type or all-zero bytes, holds all-zero bytes that are no value of this type, as a null object reference, a string of type index None or a zero device type: a field that a creator left undefined for reflection to set, as C++ UnsafeInit leaves a reference undefined (null). Unlike a C++ undefined reference, it is no value; a nullable reference is Option<T>, whose None is a defined value.

fn type_str() -> String

the type string of the type

unsafe fn copy_to_any_view(src: &Self, data: &mut TVMFFIAny)

the value to copy to TVMFFIAny

unsafe fn check_any_strict(data: &TVMFFIAny) -> bool

unsafe fn copy_from_any_view_after_check(data: &TVMFFIAny) -> Self

Copy value from TVMFFIAny after checking caller must ensure that the value is compatible with the type

unsafe fn move_to_any(src: Self, data: &mut TVMFFIAny)

consume the value to move to Any

unsafe fn move_from_any_after_check(data: &mut TVMFFIAny) -> Self

the value to move from TVMFFIAny NOTE: pay very careful attention to avoid memory leak!

unsafe fn try_cast_from_any_view(data: &TVMFFIAny) -> Result<Self, ()>

try to cast the value from AnyView

fn get_mismatch_type_info(data: &TVMFFIAny) -> String

Get the type key of a type when TryCastFromAnyView fails.

fn type_schema() -> String

The type schema of the type: the JSON object C++ TypeTraits<T>::TypeSchema writes, which the type schemas of functions and fields embed.

fn to_any(&self) -> Any

Borrow self into an owned Any, increfing object-backed values.

impl<'a> ArgIntoRef for &'a Module

type Target = Module

fn to_ref(&self) -> &Self::Target

impl ArgIntoRef for Module

type Target = Module

fn to_ref(&self) -> &Self::Target

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<&Module> for Module

fn from(value: &Module) -> Self

Converts to this type from the input type.

impl<'a> IntoArgHolder for &'a Module

type Target = &'a Module

fn into_arg_holder(self) -> Self::Target

impl IntoArgHolder for Module

type Target = Module

fn into_arg_holder(self) -> Self::Target

impl ObjectRefCore for Module

type ContainerType = <ObjectArc<ModuleObj> as Deref>::Target

fn data(this: &Self) -> &ObjectArc<Self::ContainerType>

fn into_data(this: Self) -> ObjectArc<Self::ContainerType>

unsafe fn from_data(data: ObjectArc<Self::ContainerType>) -> Self

Construct a reference view from an owning container handle.

fn same_as<Other: ObjectRefCore>(&self, other: &Other) -> bool

Return whether two object references point to the same allocation.

fn downcast_ref<T: ObjectCore>(&self) -> Option<&T>

Borrow the underlying object as T when its runtime type is T or a subtype.

impl TryFrom<Any> for Module

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Any) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<AnyView<'a>> for Module

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AnyView<'a>) -> Result<Self, Self::Error>

Performs the conversion.