pub struct ImportObject;
Expand description

An ImportObject represents all of the import data used when instantiating a WebAssembly module.

Example

Importing a function, math.sum, and call it through the exported add_one function:

def sum(x, y)
  x + y
end

store = Wasmer::Store.new
module_ = Wasmer::Module.new(
  store,
  (<<~WAST)
  (module
    (import "math" "sum" (func $sum (param i32 i32) (result i32)))
    (func (export "add_one") (param i32) (result i32)
      local.get 0
      i32.const 1
      call $sum))
  WAST
)

import_object = Wasmer::ImportObject.new
import_object.register(
  "math",
  {
    :sum => Wasmer::Function.new(
      store,
      method(:sum),
      Wasmer::FunctionType.new([Wasmer::Type::I32, Wasmer::Type::I32], [Wasmer::Type::I32])
    )
  }
)

instance = Wasmer::Instance.new module_, import_object

assert { instance.exports.add_one.(1) == 2 }

Importing a memory:

store = Wasmer::Store.new
module_ = Wasmer::Module.new(
  store,
  (<<~WAST)
  (module
    (import "env" "memory" (memory $memory 1))
    (func (export "increment")
      i32.const 0
      i32.const 0
      i32.load    ;; load 0
      i32.const 1
      i32.add     ;; add 1
      i32.store   ;; store at 0
      ))
  WAST
)

memory = Wasmer::Memory.new store, Wasmer::MemoryType.new(1, nil, false)
view = memory.uint8_view(0)

import_object = Wasmer::ImportObject.new
import_object.register(
  "env",
  {
    :memory => memory,
  }
)

instance = Wasmer::Instance.new module_, import_object

assert { view[0] == 0 }

instance.exports.increment.()
assert { view[0] == 1 }

instance.exports.increment.()
assert { view[0] == 2 }

Importing a global:

store = Wasmer::Store.new
module_ = Wasmer::Module.new(
  store,
  (<<~WAST)
    (module
      (import "env" "global" (global $global (mut i32)))
      (func (export "read_g") (result i32)
        global.get $global)
      (func (export "write_g") (param i32)
        local.get 0
        global.set $global))
  WAST
)

global = Wasmer::Global.new store, Wasmer::Value.i32(7), true

import_object = Wasmer::ImportObject.new
import_object.register(
  "env",
  {
    :global => global
  }
)

instance = Wasmer::Instance.new module_, import_object

assert { instance.exports.read_g.() == 7 }

global.value = 153
assert { instance.exports.read_g.() == 153 }

instance.exports.write_g.(11)
assert { global.value == 11 }

etc.

Implementations§

source§

impl ImportObject

source

pub fn new() -> Self

Creates a new ImportObject.

source

pub fn contains_namespace(&self, namespace_name: String) -> Boolean

Checks whether the import object contains a specific namespace.

source

pub fn register(&self, namespace_name: String, namespace: Hash<String, Any>)

Registers a set of Function, Memory, Global or Table to a particular namespace.

See the ImportObject’s documentation to see more examples.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.