Expand description
This are the common types and utility tools for using WebAssembly in a Rust environment.
This crate provides common structures such as Type
or Value
, type indexes
and native function wrappers with Func
.
Modules§
- entity
- The entity module, with common helpers for Rust structures
- lib
- The
lib
module defines astd
module that is identical whether thecore
or thestd
feature is enabled.
Macros§
- entity_
impl - Macro which provides the common implementation of a 32-bit entity reference.
Structs§
- Archivable
Index Map - See
IndexMap
- Atomically
- Atomically.
- Bytes
- Units of WebAssembly memory in terms of 8-bit bytes.
- Custom
Section Index - Index type of a custom section inside a WebAssembly module.
- Data
Index - Index type of a passive data segment inside the WebAssembly module.
- Data
Initializer - A data initializer for linear memory.
- Data
Initializer Location - A memory index and offset within that memory where a data initialization should be performed.
- Elem
Index - Index type of a passive element segment inside the WebAssembly module.
- Export
Type - A descriptor for an exported WebAssembly value.
- Extern
Ref - An opaque reference to some data. This reference can be passed through Wasm.
- Fast
GasCounter - Fast gas counter with very simple structure, could be exposed to compiled code in the VM.
- Features
- Controls which experimental features will be enabled. Features usually have a corresponding WebAssembly proposal.
- Function
Index - Index type of a function (imported or local) inside the WebAssembly module.
- Function
Type - The signature of a function that is either implemented in a Wasm module or exposed to Wasm by the host.
- Function
Type Ref - Borrowed version of
FunctionType
. - Global
Index - Index type of a global variable (imported or local) inside the WebAssembly module.
- Global
Type - WebAssembly global.
- Import
- A descriptor for an imported value into a wasm module.
- Import
Counts - The counts of imported entities in a WebAssembly module.
- Instance
Config - External configuration of execution environment for Instance.
- Local
Function Index - Index type of a function defined locally inside the WebAssembly module.
- Local
Global Index - Index type of a global defined locally inside the WebAssembly module.
- Local
Memory Index - Index type of a memory defined locally inside the WebAssembly module.
- Local
Table Index - Index type of a table defined locally inside the WebAssembly module.
- Memory
Index - Index type of a linear memory (imported or local) inside the WebAssembly module.
- Memory
Type - A descriptor for a WebAssembly memory type.
- Memory
View - A view into a memory.
- Module
Info - A translated WebAssembly module, excluding the function bodies and memory initializers.
- Owned
Data Initializer - As
DataInitializer
but owning the data rather than holding a reference to it - Owned
Table Initializer - A WebAssembly table initializer.
- Page
Count OutOf Range - The only error that can happen when converting
Bytes
toPages
- Pages
- Units of WebAssembly pages (as specified to be 65,536 bytes).
- Signature
Index - Index type of a signature (imported or local) inside the WebAssembly module.
- Table
Index - Index type of a table (imported or local) inside the WebAssembly module.
- Table
Type - A descriptor for a table in a WebAssembly module.
- V128
- The WebAssembly V128 type
- VMExtern
Ref - This type does not do reference counting automatically, reference counting can be done with
Self::ref_clone
andSelf::ref_drop
.
Enums§
- Export
Index - An entity to export.
- Extern
Type - A list of all possible types which can be externally referenced from a WebAssembly module.
- Global
Init - Globals are initialized via the
const
operators or by referring to another import. - Import
Index - An entity to import.
- Mutability
- Indicator of whether a global is mutable or not
- Type
- A list of all possible value types in WebAssembly.
- Value
- Possible runtime values that a WebAssembly module can either consume or produce.
Constants§
- VERSION
- Version number of this crate.
- WASM_
MAX_ PAGES - The number of pages we can have before we run out of byte index space.
- WASM_
MIN_ PAGES - The minimum number of pages allowed.
- WASM_
PAGE_ SIZE - WebAssembly page sizes are fixed to be 64KiB. Note: large page support may be added in an opt-in manner in the future.
Traits§
- Native
Wasm Type NativeWasmType
represents a Wasm type that has a direct representation on the host (hence the “native” term).- Value
Type - Trait for a Value type. A Value type is a type that is always valid and may be safely copied.
- Wasm
Value Type - Trait for reading and writing Wasm values into binary for use on the layer
between the API and the VM internals, specifically with
wasmer_types::Value
.