Struct sc_executor_common::sandbox::SandboxInstance
source · [−]pub struct SandboxInstance<FR> { /* private fields */ }
Expand description
Sandboxed instance of a wasm module.
It’s primary purpose is to invoke
exported functions on it.
All imports of this instance are specified at the creation time and imports are implemented by the supervisor.
Hence, in order to invoke an exported function on a sandboxed module instance, it’s required to provide supervisor externals: it will be used to execute code in the supervisor context.
This is generic over a supervisor function reference type.
Implementations
sourceimpl<FR> SandboxInstance<FR>
impl<FR> SandboxInstance<FR>
sourcepub fn invoke<FE: SandboxCapabilities<SupervisorFuncRef = FR>>(
&self,
export_name: &str,
args: &[RuntimeValue],
supervisor_externals: &mut FE,
state: u32
) -> Result<Option<RuntimeValue>, Error>
pub fn invoke<FE: SandboxCapabilities<SupervisorFuncRef = FR>>(
&self,
export_name: &str,
args: &[RuntimeValue],
supervisor_externals: &mut FE,
state: u32
) -> Result<Option<RuntimeValue>, Error>
Invoke an exported function by a name.
supervisor_externals
is required to execute the implementations
of the syscalls that published to a sandboxed module instance.
The state
parameter can be used to provide custom data for
these syscall implementations.
sourcepub fn get_global_val(&self, name: &str) -> Option<Value>
pub fn get_global_val(&self, name: &str) -> Option<Value>
Get the value from a global with the given name
.
Returns Some(_)
if the global could be found.
Auto Trait Implementations
impl<FR> !RefUnwindSafe for SandboxInstance<FR>
impl<FR> !Send for SandboxInstance<FR>
impl<FR> !Sync for SandboxInstance<FR>
impl<FR> Unpin for SandboxInstance<FR> where
FR: Unpin,
impl<FR> !UnwindSafe for SandboxInstance<FR>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
sourceimpl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
sourcepub fn unchecked_into(self) -> T
pub fn unchecked_into(self) -> T
The counterpart to unchecked_from
.