Struct soroban_wasmi::Table

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

A Wasm table reference.

Implementations

impl Table

pub fn new( ctx: impl AsContextMut, ty: TableType, init: Value ) -> Result<Self, TableError>

Creates a new table to the store.

Errors

If init does not match the TableType element type.

pub fn ty(&self, ctx: impl AsContext) -> TableType

Returns the type and limits of the table.

Panics

Panics if ctx does not own this Table.

pub fn size(&self, ctx: impl AsContext) -> u32

Returns the current size of the Table.

Panics

If ctx does not own this Table.

pub fn grow( &self, ctx: impl AsContextMut, delta: u32, init: Value ) -> Result<u32, TableError>

Grows the table by the given amount of elements.

Returns the old size of the Table upon success.

Note

The newly added elements are initialized to the init Value.

Errors

• If the table is grown beyond its maximum limits.
• If value does not match the Table element type.

Panics

Panics if ctx does not own this Table.

pub fn get(&self, ctx: impl AsContext, index: u32) -> Option<Value>

Returns the Table element value at index.

Returns None if index is out of bounds.

Panics

Panics if ctx does not own this Table.

pub fn set( &self, ctx: impl AsContextMut, index: u32, value: Value ) -> Result<(), TableError>

Sets the Value of this Table at index.

Errors

• If index is out of bounds.
• If value does not match the Table element type.

Panics

Panics if ctx does not own this Table.

pub fn copy( store: impl AsContextMut, dst_table: &Table, dst_index: u32, src_table: &Table, src_index: u32, len: u32 ) -> Result<(), TableError>

Copy len elements from src_table[src_index..] into dst_table[dst_index..].

Errors

Returns an error if the range is out of bounds of either the source or destination tables.

Panics

Panics if store does not own either dst_table or src_table.

pub fn fill( &self, ctx: impl AsContextMut, dst: u32, val: Value, len: u32 ) -> Result<(), TrapCode>

Fill table[dst..(dst + len)] with the given value.

Errors

• If val has a type mismatch with the element type of the Table.
• If the region to be filled is out of bounds for the Table.
• If val originates from a different Store than the Table.

Panics

If ctx does not own dst_table or src_table.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl From<Table> for Extern

fn from(table: Table) -> Self

Converts to this type from the input type.

impl Copy for Table