Crate wasmedge_sdk

source ·
Expand description

Overview

WasmEdge Rust SDK provides idiomatic Rust language bindings for WasmEdge

Notice: This project is still under active development and not guaranteed to have a stable API.

Get Started

Since this crate depends on the WasmEdge C API, it needs to be installed in your system first. Please refer to WasmEdge Installation and Uninstallation to install the WasmEdge library. The versioning table below shows the version of the WasmEdge library required by each version of the wasmedge-sdk crate.

wasmedge-sdkWasmEdge libwasmedge-syswasmedge-typeswasmedge-macroasync-wasi
0.13.00.13.50.17.30.4.40.6.10.1.0
0.12.20.13.40.17.20.4.40.6.10.1.0
0.12.10.13.40.17.10.4.40.6.10.1.0
0.12.00.13.40.17.00.4.40.6.10.1.0
0.11.20.13.30.16.20.4.30.6.10.1.0
0.11.00.13.30.16.00.4.30.6.00.0.3
0.10.10.13.30.15.10.4.20.5.00.0.2
0.10.00.13.20.15.00.4.20.5.00.0.2
0.9.00.13.10.14.00.4.20.4.00.0.1
0.9.00.13.00.14.00.4.20.4.00.0.1
0.8.10.12.10.13.10.4.10.3.0-
0.8.00.12.00.13.00.4.10.3.0-
0.7.10.11.20.12.20.3.10.3.0-
0.7.00.11.20.120.3.10.3.0-
0.6.00.11.20.110.3.00.2.0-
0.5.00.11.10.100.3.00.1.0-
0.4.00.11.00.90.2.1--
0.3.00.10.10.80.2--
0.1.00.10.00.70.1--

WasmEdge Rust SDK will automatically search for the WasmEdge library in your system. Alternatively you can set the WASMEDGE_DIR environment variable to the path of the WasmEdge library (or the WASMEDGE_INCLUDE_DIR and WASMEDGE_LIB_DIR variables for more fine-grained control). If you want to use a local cmake build of WasmEdge you can set the WASMEDGE_BUILD_DIR instead.

WasmEdge Rust SDK will search for the WasmEdge library in the following paths in order:

  • $WASMEDGE_[INCLUDE|LIB]_DIR
  • $WASMEDGE_DIR
  • $WASMEDGE_BUILD_DIR
  • $HOME/.wasmedge
  • /usr/local
  • $HOME/.local

When the standalone feature is enabled the correct library will be downloaded during build time and the previous locations are ignored. You can specify a proxy for the download process using the WASMEDGE_STANDALONE_PROXY, WASMEDGE_STANDALONE_PROXY_USER and WASMEDGE_STANDALONE_PROXY_PASS environment variables. You can set the WASMEDGE_STANDALONE_ARCHIVE environment variable to use a local archive instead of downloading one. The following architectures are supported for automatic downloads:

oslibcarchitecturelinking type
macos-x86_64, aarch64dynamic
linuxglibcx86_64, aarch64static, dynamic
linuxmuslx86_64, aarch64static

This crate uses rust-bindgen during the build process. If you would like to use an external rust-bindgen you can set the WASMEDGE_RUST_BINDGEN_PATH environment variable to the bindgen executable path. This is particularly useful in systems like Alpine Linux (see rust-lang/rust-bindgen#2360, rust-lang/rust-bindgen#2333).

Notice: The minimum supported Rust version is 1.71.

API Reference

Examples

The Examples of WasmEdge RustSDK repo contains a number of examples that demonstrate how to use the WasmEdge Rust SDK.

Contributing

Please read the contribution guidelines on how to contribute code.

License

This project is licensed under the terms of the Apache 2.0 license.

Modules

  • config
    Defines the structs used to construct configurations.
  • dock
    Defines WasmEdge VmDock and Param types.
  • error
    Defines WasmEdge error types.
  • plugin
    Defines plugin related structs.
  • types
    Defines the general types.
  • utils
    Defines WasmEdge Driver and CoreVersion types
  • wasi
    Defines wasi module instance.

Macros

Structs

  • Caller
    Represents the calling frame on top of stack.
  • Compileraot
    Defines WasmEdge ahead-of-time(AOT) compiler and the relevant APIs.
  • Executor
    Defines an execution environment for both pure WASM and compiled WASM.
  • ExportType
    Defines the types of the exported instances.
  • Func
    Defines a host function instance.
  • FuncRef
    Defines a reference to a host function.
  • FuncType
    Struct of WasmEdge FuncType.
  • FuncTypeBuilder
    Defines a type builder for creating a FuncType instance.
  • Global
    Defines a WebAssembly global variable, which stores a single value of the given GlobalType and a flag indicating whether it is mutable or not.
  • GlobalType
    Struct of WasmEdge GlobalType.
  • ImportObject
    Defines an import object that contains the required import data used when instantiating a module.
  • ImportObjectBuilder
    Creates a normal or wasi import object.
  • ImportType
    Defines the types of the imported instances.
  • Instance
    Represents an instantiated module.
  • LogManager
    Manipulates the runtime logger.
  • Memory
    Defines a linear memory.
  • MemoryType
    Struct of WasmEdge MemoryType.
  • Module
    Defines compiled in-memory representation of an input WASM binary.
  • Statistics
    Used to collect statistics of the WasmEdge runtime, such as the count of instructions in execution.
  • Store
    Represents all global state that can be manipulated by WebAssembly programs. A store consists of the runtime representation of all instances of functions, tables, memories, and globals.
  • Table
    Defines a table storing the references to host functions or external objects.
  • TableType
    Struct of WasmEdge TableType.
  • Vm
    A Vm defines a virtual environment for managing WebAssembly programs.
  • VmBuilder
    Constructs a Vm instance.

Enums

Traits

  • AsInstance
    The object used as an module instance is required to implement this trait.
  • Engine
    The object that is used to perform a host function is required to implement this trait.
  • WasmVal
    Defines the function converting a value of Rust type to the one of Wasm type.
  • WasmValType
    Describes the mapping of Rust type to Wasm type.
  • WasmValTypeList
    Describes the mapping of a tuple of Rust types to Wasm types.

Functions

Type Aliases

Attribute Macros

  • async_host_functionasync and Linux
    Declare a native async function that will be used to create an async host function instance.
  • host_function
    Declare a native function that will be used to create a host function instance.