Skip to main content

WasmSandbox

Struct WasmSandbox 

Source
pub struct WasmSandbox { /* private fields */ }
Expand description

A sandbox with just the Wasm engine loaded into memory. WasmSandboxes are not yet ready to execute guest functions.

Before you can call guest functions, you must call the load_module function to load a Wasm module into memory. That function will return a LoadedWasmSandbox able to execute code in the loaded Wasm Module.

Implementations§

Source§

impl WasmSandbox

Source

pub fn load_module(self, file: impl AsRef<Path>) -> Result<LoadedWasmSandbox>

Load a Wasm module at the given path into the sandbox and return a LoadedWasmSandbox able to execute code in the loaded Wasm Module.

Before you can call guest functions in the sandbox, you must call this function and use the returned value to call guest functions.

Source

pub fn load_from_snapshot( self, snapshot: Arc<Snapshot>, ) -> Result<LoadedWasmSandbox>

Load a Wasm module by restoring a Hyperlight snapshot taken from a LoadedWasmSandbox.

Source

pub unsafe fn load_module_by_mapping( self, base: *mut c_void, len: usize, ) -> Result<LoadedWasmSandbox>

Load a Wasm module that is currently present in a buffer in host memory, by mapping the host memory directly into the sandbox.

Depending on the host platform, there are likely alignment requirements of at least one page for base and len

§Safety

It is the caller’s responsibility to ensure that the host side of the region remains intact and is not written to until the produced LoadedWasmSandbox is discarded or devolved.

Source

pub fn load_module_from_buffer(self, buffer: &[u8]) -> Result<LoadedWasmSandbox>

Load a Wasm module from a buffer of bytes into the sandbox and return a LoadedWasmSandbox able to execute code in the loaded Wasm Module.

Before you can call guest functions in the sandbox, you must call this function and use the returned value to call guest functions.

Trait Implementations§

Source§

impl Debug for WasmSandbox

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for WasmSandbox

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more