Struct Engine 

pub struct Engine { /* private fields */ }

A WebAssembly Universal Engine.

Implementations

impl Engine

pub fn new( compiler_config: Box<dyn CompilerConfig>, target: Target, features: Features, ) -> Self

Available on (crate features std or core) and crate feature compiler only.

Create a new Engine with the given config

pub fn name(&self) -> &str

Available on crate features std or core only.

Returns the name of this engine

pub fn deterministic_id(&self) -> String

Available on crate features std or core only.

Returns the deterministic id of this engine

pub fn headless() -> Self

Available on crate features std or core only.

Create a headless Engine

A headless engine is an engine without any compiler attached. This is useful for assuring a minimal runtime for running WebAssembly modules.

For example, for running in IoT devices where compilers are very expensive, or also to optimize startup speed.

Important

Headless engines can’t compile or validate any modules, they just take already processed Modules (via Module::serialize).

pub fn inner(&self) -> MutexGuard<'_, EngineInner>

Available on crate features std or core only.

Get reference to EngineInner.

pub fn inner_mut(&self) -> MutexGuard<'_, EngineInner>

Available on crate features std or core only.

Get mutable reference to EngineInner.

pub fn target(&self) -> &Target

Available on crate features std or core only.

Gets the target

pub fn register_signature( &self, func_type: &FunctionType, ) -> VMSharedSignatureIndex

Available on (crate features std or core) and non-WebAssembly only.

Register a signature

pub fn lookup_signature( &self, sig: VMSharedSignatureIndex, ) -> Option<FunctionType>

Available on (crate features std or core) and non-WebAssembly only.

Lookup a signature

pub fn validate(&self, binary: &[u8]) -> Result<(), CompileError>

Available on (crate features std or core) and crate feature compiler only.

Validates a WebAssembly module

pub fn compile(&self, binary: &[u8]) -> Result<Arc<Artifact>, CompileError>

Available on (crate features std or core) and crate feature compiler and non-WebAssembly only.

Compile a WebAssembly binary

pub fn compile_with_progress( &self, binary: &[u8], progress_callback: Option<CompilationProgressCallback>, ) -> Result<Arc<Artifact>, CompileError>

Available on (crate features std or core) and crate feature compiler only.

Compile a WebAssembly binary with a progress callback.

pub unsafe fn deserialize_unchecked( &self, bytes: OwnedBuffer, ) -> Result<Arc<Artifact>, DeserializeError>

Available on (crate features std or core) and non-WebAssembly only.

Deserializes a WebAssembly module which was previously serialized with [wasmer::Module::serialize].

Safety

See Artifact::deserialize_unchecked.

pub unsafe fn deserialize( &self, bytes: OwnedBuffer, ) -> Result<Arc<Artifact>, DeserializeError>

Available on (crate features std or core) and non-WebAssembly only.

Deserializes a WebAssembly module which was previously serialized with [wasmer::Module::serialize].

Safety

See Artifact::deserialize.

pub unsafe fn deserialize_from_file( &self, file_ref: &Path, ) -> Result<Arc<Artifact>, DeserializeError>

Available on (crate features std or core) and non-WebAssembly only.

Deserializes a WebAssembly module from a path.

Safety

See Artifact::deserialize.

pub unsafe fn deserialize_from_file_unchecked( &self, file_ref: &Path, ) -> Result<Arc<Artifact>, DeserializeError>

Available on (crate features std or core) and non-WebAssembly only.

Deserialize from a file path.

Safety

See Artifact::deserialize_unchecked.

pub fn id(&self) -> &EngineId

Available on crate features std or core only.

A unique identifier for this object.

This exists to allow us to compare two Engines for equality. Otherwise, comparing two trait objects unsafely relies on implementation details of trait representation.

pub fn cloned(&self) -> Self

Available on crate features std or core only.

Clone the engine

pub fn set_tunables(&mut self, tunables: impl Tunables + Send + Sync + 'static)

Available on (crate features std or core) and non-WebAssembly only.

Attach a Tunable to this engine

pub fn tunables(&self) -> &dyn Tunables

Available on (crate features std or core) and non-WebAssembly only.

Get a reference to attached Tunable of this engine

pub fn with_opts( &mut self, _suggested_opts: &UserCompilerOptimizations, ) -> Result<(), CompileError>

Available on crate features std or core only.

Add suggested optimizations to this engine.

Note

Not every backend supports every optimization. This function may fail (i.e. not set the suggested optimizations) silently if the underlying engine backend does not support one or more optimizations.

Trait Implementations

impl Clone for Engine

Available on crate features std or core only.

fn clone(&self) -> Engine

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Engine

Available on crate features std or core only.

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

Formats the value using the given formatter.

impl From<&Engine> for Engine

Available on crate features std or core only.

fn from(engine_ref: &Self) -> Self

Converts to this type from the input type.

impl From<Box<dyn CompilerConfig>> for Engine

Available on (crate features std or core) and crate feature compiler only.

fn from(config: Box<dyn CompilerConfig>) -> Self

Converts to this type from the input type.

impl From<EngineBuilder> for Engine

Available on crate features std or core only.

fn from(engine_builder: EngineBuilder) -> Self

Converts to this type from the input type.