Struct wasmi::TableInstance

pub struct TableInstance { /* private fields */ }

Runtime representation of a table.

A table is a array of untyped functions. It allows wasm code to call functions indirectly through a dynamic index into a table. For example, this allows emulating function pointers by way of table indices.

Table is created with an initial size but can be grown dynamically via grow method. Growth can be limited by an optional maximum size.

In future, a table might be extended to be able to hold not only functions but different types.

Implementations

impl TableInstance

pub fn alloc(
    initial_size: u32,
    maximum_size: Option<u32>
) -> Result<TableRef, Error>

Allocate a table instance.

The table allocated with initial size, specified by initial_size. Maximum size can be specified by maximum_size.

All table elements are allocated uninitialized.

Errors

Returns Err if initial_size is greater than maximum_size.

pub fn initial_size(&self) -> u32

Returns size this table was created with.

pub fn maximum_size(&self) -> Option<u32>

Returns maximum size TableInstance can grow to.

pub fn current_size(&self) -> u32

Returns current size of the table.

pub fn grow(&self, by: u32) -> Result<(), Error>

Increases the size of the table by given number of elements.

Errors

Returns Err if tried to allocate more elements than permited by limit.

pub fn get(&self, offset: u32) -> Result<Option<FuncRef>, Error>

Get the specific value in the table

pub fn set(&self, offset: u32, value: Option<FuncRef>) -> Result<(), Error>

Set the table element to the specified function.

Trait Implementations

impl Debug for TableInstance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.