Struct Instance

pub struct Instance(/* private fields */);

Available on crate features runtime and component-model only.

An instantiated component.

This type represents an instantiated Component. Instances have exports which can be accessed through functions such as Instance::get_func or Instance::exports. Instances are owned by a Store and all methods require a handle to the store.

Component instances are created through Linker::instantiate and its family of methods.

This type is similar to the core wasm version wasmtime::Instance except that it represents an instantiated component instead of an instantiated module.

Implementations

impl Instance

pub fn exports<'a, T: 'a>( &self, store: impl Into<StoreContextMut<'a, T>>, ) -> Exports<'a>

Returns information about the exports of this instance.

This method can be used to extract exported values from this component instance. The argument to this method be a handle to the store that this instance was instantiated into.

The returned Exports value can be used to lookup exported items by name.

Panics

Panics if store does not own this instance.

pub fn get_func(&self, store: impl AsContextMut, name: &str) -> Option<Func>

Looks up a function by name within this Instance.

This is a convenience method for calling Instance::exports followed by ExportInstance::func.

Panics

Panics if store does not own this instance.

pub fn get_typed_func<Params, Results>( &self, store: impl AsContextMut, name: &str, ) -> Result<TypedFunc<Params, Results>>

where Params: ComponentNamedList + Lower, Results: ComponentNamedList + Lift,

Looks up an exported Func value by name and with its type.

This function is a convenience wrapper over Instance::get_func and Func::typed. For more information see the linked documentation.

Returns an error if name isn’t a function export or if the export’s type did not match Params or Results

Panics

Panics if store does not own this instance.

pub fn get_module(&self, store: impl AsContextMut, name: &str) -> Option<Module>

Looks up a module by name within this Instance.

The store specified must be the store that this instance lives within and name is the name of the function to lookup. If the module is found Some is returned otherwise None is returned.

Panics

Panics if store does not own this instance.

pub fn get_resource( &self, store: impl AsContextMut, name: &str, ) -> Option<ResourceType>

Looks up an exported resource type by name within this Instance.

The store specified must be the store that this instance lives within and name is the name of the function to lookup. If the resource type is found Some is returned otherwise None is returned.

Panics

Panics if store does not own this instance.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Instance