Struct soroban_wasmi::StoreLimitsBuilder

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

Used to build StoreLimits.

Implementations

impl StoreLimitsBuilder

pub fn new() -> Self

Creates a new StoreLimitsBuilder.

See the documentation on each builder method for the default for each value.

pub fn memory_size(self, limit: usize) -> Self

The maximum number of bytes a linear memory can grow to.

Growing a linear memory beyond this limit will fail. This limit is applied to each linear memory individually, so if a wasm module has multiple linear memories then they’re all allowed to reach up to the limit specified.

By default, linear memory will not be limited.

pub fn table_elements(self, limit: u32) -> Self

The maximum number of elements in a table.

Growing a table beyond this limit will fail. This limit is applied to each table individually, so if a wasm module has multiple tables then they’re all allowed to reach up to the limit specified.

By default, table elements will not be limited.

pub fn instances(self, limit: usize) -> Self

The maximum number of instances that can be created for a Store.

Module instantiation will fail if this limit is exceeded.

This value defaults to 10,000.

pub fn tables(self, tables: usize) -> Self

The maximum number of tables that can be created for a Store.

Module instantiation will fail if this limit is exceeded.

This value defaults to 10,000.

pub fn memories(self, memories: usize) -> Self

The maximum number of linear memories that can be created for a Store.

Instantiation will fail with an error if this limit is exceeded.

This value defaults to 10,000.

pub fn trap_on_grow_failure(self, trap: bool) -> Self

Indicates that a trap should be raised whenever a growth operation would fail.

This operation will force memory.grow and table.grow instructions to raise a trap on failure instead of returning -1. This is not necessarily spec-compliant, but it can be quite handy when debugging a module that fails to allocate memory and might behave oddly as a result.

This value defaults to false.

pub fn build(self) -> StoreLimits

Consumes this builder and returns the StoreLimits.

Trait Implementations

impl Default for StoreLimitsBuilder

fn default() -> Self

Returns the “default value” for a type.