Struct sc_executor_common::sandbox::Store

pub struct Store<DT> { /* private fields */ }

This struct keeps track of all sandboxed components.

This is generic over a supervisor function reference type.

Implementations

impl<DT: Clone> Store<DT>

pub fn new(backend: SandboxBackend) -> Self

Create a new empty sandbox store.

pub fn new_memory(&mut self, initial: u32, maximum: u32) -> Result<u32>

Create a new memory instance and return it’s index.

Errors

Returns Err if the memory couldn’t be created. Typically happens if initial is more than maximum.

pub fn instance(&self, instance_idx: u32) -> Result<Rc<SandboxInstance>>

Returns SandboxInstance by instance_idx.

Errors

Returns Err If instance_idx isn’t a valid index of an instance or instance is already torndown.

pub fn dispatch_thunk(&self, instance_idx: u32) -> Result<DT>

Returns dispatch thunk by instance_idx.

Errors

Returns Err If instance_idx isn’t a valid index of an instance or instance is already torndown.

pub fn memory(&self, memory_idx: u32) -> Result<Memory>

Returns reference to a memory instance by memory_idx.

Errors

Returns Err If memory_idx isn’t a valid index of an memory or if memory has been torn down.

pub fn memory_teardown(&mut self, memory_idx: u32) -> Result<()>

Tear down the memory at the specified index.

Errors

Returns Err if memory_idx isn’t a valid index of an memory or if it has been torn down.

pub fn instance_teardown(&mut self, instance_idx: u32) -> Result<()>

Tear down the instance at the specified index.

Errors

Returns Err if instance_idx isn’t a valid index of an instance or if it has been torn down.

pub fn instantiate(
    &mut self,
    wasm: &[u8],
    guest_env: GuestEnvironment,
    state: u32,
    sandbox_context: &mut dyn SandboxContext
) -> Result<UnregisteredInstance, InstantiationError>

Instantiate a guest module and return it’s index in the store.

The guest module’s code is specified in wasm. Environment that will be available to guest module is specified in guest_env. A dispatch thunk is used as function that handle calls from guests. state is an opaque pointer to caller’s arbitrary context normally created by sp_sandbox::Instance primitive.

Note: Due to borrowing constraints dispatch thunk is now propagated using DTH

Returns uninitialized sandboxed module instance or an instantiation error.