wasmedge_sys

Struct WasiModule

Source
pub struct WasiModule(/* private fields */);
Expand description

A WasiModule is a module instance for the WASI specification.

Implementations§

Source§

impl WasiModule

Source

pub fn create( args: Option<Vec<&str>>, envs: Option<Vec<&str>>, preopens: Option<Vec<&str>>, ) -> WasmEdgeResult<Self>

Creates a WASI host module which contains the WASI host functions, and initializes it with the given parameters.

§Arguments
  • args - The commandline arguments. The first argument is the program name.

  • envs - The environment variables in the format ENV_VAR_NAME=VALUE.

  • preopens - The directories to pre-open. The required format is GUEST_PATH:HOST_PATH.

§Error

If fail to create a host module, then an error is returned.

Source

pub fn name(&self) -> &str

Returns the name of the module instance.

Source

pub fn init_wasi( &mut self, args: Option<Vec<&str>>, envs: Option<Vec<&str>>, preopens: Option<Vec<&str>>, )

Initializes the WASI host module with the given parameters.

§Arguments
  • args - The commandline arguments. The first argument is the program name.

  • envs - The environment variables in the format ENV_VAR_NAME=VALUE.

  • preopens - The directories to pre-open. The required format is GUEST_PATH:HOST_PATH.

Source

pub fn exit_code(&self) -> u32

Returns the WASI exit code.

The WASI exit code can be accessed after running the “_start” function of a wasm32-wasi program.

Source

pub fn get_native_handler(&self, fd: i32) -> WasmEdgeResult<u64>

Returns the native handler from the mapped FD/Handler.

§Argument
  • fd - The WASI mapped Fd.
§Error

If fail to get the native handler, then an error is returned.

Trait Implementations§

Source§

impl AsMut<Instance> for WasiModule

Source§

fn as_mut(&mut self) -> &mut Instance

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl AsRef<Instance> for WasiModule

Source§

fn as_ref(&self) -> &Instance

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Debug for WasiModule

Source§

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

Formats the value using the given formatter. 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<Inst> AsInstance for Inst
where Inst: AsMut<Instance> + AsRef<Instance>,

Source§

unsafe fn as_ptr(&self) -> *const WasmEdge_ModuleInstanceContext

Safety Read more
Source§

fn name(&self) -> Option<String>

Returns the name of this exported module instance. Read more
Source§

fn get_table( &self, name: impl AsRef<str>, ) -> WasmEdgeResult<InnerRef<Table, &Self>>
where Self: Sized,

Returns the exported table instance by name. Read more
Source§

fn get_memory_ref( &self, name: impl AsRef<str>, ) -> WasmEdgeResult<InnerRef<Memory, &Self>>
where Self: Sized,

Returns the exported memory instance by name. Read more
Source§

fn get_memory_mut( &mut self, name: impl AsRef<str>, ) -> WasmEdgeResult<InnerRef<Memory, &mut Self>>
where Self: Sized,

Source§

fn get_global( &self, name: impl AsRef<str>, ) -> WasmEdgeResult<InnerRef<Global, &Self>>
where Self: Sized,

Returns the exported global instance by name. Read more
Source§

fn get_global_mut( &mut self, name: impl AsRef<str>, ) -> WasmEdgeResult<InnerRef<Global, &mut Self>>
where Self: Sized,

Source§

fn func_len(&self) -> u32

Returns the length of the exported function instances in this module instance.
Source§

fn func_names(&self) -> Option<Vec<String>>

Returns the names of the exported function instances in this module instance.
Source§

fn get_func(&self, name: &str) -> WasmEdgeResult<FuncRef<&Instance>>

Returns the exported function instance by name. Read more
Source§

fn get_func_mut(&mut self, name: &str) -> WasmEdgeResult<FuncRef<&mut Instance>>

Returns the exported function instance by name. Read more
Source§

fn table_len(&self) -> u32

Returns the length of the exported table instances in this module instance.
Source§

fn table_names(&self) -> Option<Vec<String>>

Returns the names of the exported table instances in this module instance.
Source§

fn mem_len(&self) -> u32

Returns the length of the exported memory instances in this module instance.
Source§

fn mem_names(&self) -> Option<Vec<String>>

Returns the names of all exported memory instances in this module instance.
Source§

fn global_len(&self) -> u32

Returns the length of the exported global instances in this module instance.
Source§

fn global_names(&self) -> Option<Vec<String>>

Returns the names of the exported global instances in this module instance.
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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.