Struct Engine 

pub struct Engine {
    inner: Arc<Mutex<EngineInner>>,
    target: Arc<Target>,
    engine_id: EngineId,
    tunables: Arc<dyn Tunables + Sync + Send>,
    name: String,
}

A WebAssembly Universal Engine.

Fields

inner: Arc<Mutex<EngineInner>>

target: Arc<Target>

engine_id: EngineId

tunables: Arc<dyn Tunables + Sync + Send>

name: String

Implementations

impl Engine

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

Create a new Engine with the given config

pub fn name(&self) -> &str

Returns the name of this engine

pub fn deterministic_id(&self) -> String

Returns the deterministic id of this engine

pub fn headless() -> Engine

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>

Get reference to EngineInner.

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

Get mutable reference to EngineInner.

pub fn target(&self) -> &Target

Gets the target

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

Register a signature

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

Lookup a signature

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

Validates a WebAssembly module

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

Compile a WebAssembly binary

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

Compile a WebAssembly binary with a progress callback.

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

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>

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>

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>

Deserialize from a file path.

Safety

See Artifact::deserialize_unchecked.

pub fn id(&self) -> &EngineId

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) -> Engine

Clone the engine

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

Attach a Tunable to this engine

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

Get a reference to attached Tunable of this engine

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

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

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

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

Formats the value using the given formatter.

impl From<&Engine> for Engine

fn from(engine_ref: &Engine) -> Engine

Converts to this type from the input type.

impl From<&Engine> for Engine

fn from(value: &Engine) -> Self

Converts to this type from the input type.

impl From<Box<dyn CompilerConfig>> for Engine

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

Converts to this type from the input type.

impl From<Cranelift> for Engine

fn from(config: Cranelift) -> Engine

Converts to this type from the input type.

impl From<Engine> for Engine

fn from(value: Engine) -> Self

Converts to this type from the input type.

impl From<EngineBuilder> for Engine

fn from(engine_builder: EngineBuilder) -> Engine

Converts to this type from the input type.

impl From<LLVM> for Engine

fn from(config: LLVM) -> Engine

Converts to this type from the input type.

impl From<Singlepass> for Engine

fn from(config: Singlepass) -> Engine

Converts to this type from the input type.