Engine

Struct Engine 

Source
pub struct Engine { /* private fields */ }
Expand description

The Engine is the entrypoint type for the runtime. It defines the kind of steps the runtime must take to execute the WebAssembly module (compile, interpret..) and the place of execution (in-browser, host, ..).

Implementations§

Source§

impl Engine

Source

pub fn deterministic_id(&self) -> String

Returns the deterministic id of this engine.

Source

pub fn id(&self) -> EngineId

Returns the unique id of this engine.

Source

pub fn default_features_for_backend( backend: &BackendKind, target: &Target, ) -> Features

Returns the default WebAssembly features supported by this backend for a given target.

These are the features that will be enabled by default without any user configuration.

Source

pub fn supported_features_for_backend( backend: &BackendKind, target: &Target, ) -> Features

Returns all WebAssembly features supported by the specified backend for a given target.

This static method allows checking features for any backend, not just the current one.

Source

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.

Source§

impl Engine

Source

pub fn into_sys(self) -> Engine

Source

pub fn as_sys(&self) -> &Engine

Convert a reference to self into a reference crate::backend::sys::engine::Engine.

Source

pub fn as_sys_mut(&mut self) -> &mut Engine

Convert a mutable reference to self into a mutable reference crate::backend::sys::engine::Engine.

Source

pub fn is_sys(&self) -> bool

Return true if self is an engine from the sys runtime.

Trait Implementations§

Source§

impl AsEngineRef for Engine

Source§

fn as_engine_ref(&self) -> EngineRef<'_>

Create an EngineRef pointing to the underlying context.
Source§

fn maybe_as_store(&self) -> Option<StoreRef<'_>>

Source§

impl Clone for Engine

Source§

fn clone(&self) -> Engine

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Engine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Engine

Source§

fn default() -> Engine

Returns the “default value” for a type. Read more
Source§

impl From<&Engine> for Engine

Source§

fn from(value: &Engine) -> Engine

Converts to this type from the input type.
Source§

impl From<Cranelift> for Engine

Available on crate feature cranelift only.
Source§

fn from(value: Cranelift) -> Engine

Converts to this type from the input type.
Source§

impl From<Engine> for Engine

Source§

fn from(value: Engine) -> Engine

Converts to this type from the input type.
Source§

impl From<EngineBuilder> for Engine

Source§

fn from(value: EngineBuilder) -> Engine

Converts to this type from the input type.
Source§

impl NativeEngineExt for Engine

Source§

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

Create a new Engine with the given config
Source§

fn headless() -> Engine

Create a headless Engine Read more
Source§

fn target(&self) -> &Target

Gets the target
Source§

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

Attach a Tunable to this engine
Source§

fn tunables(&self) -> &dyn Tunables

Get a reference to attached Tunable of this engine
Source§

unsafe fn deserialize_from_mmapped_file_unchecked( &self, file_ref: &Path, ) -> Result<Module, DeserializeError>

Load a serialized WebAssembly module from a memory mapped file and deserialize it. Read more
Source§

unsafe fn deserialize_from_mmapped_file( &self, file_ref: &Path, ) -> Result<Module, DeserializeError>

Load a serialized WebAssembly module from a memory mapped file and deserialize it. Read more
Source§

fn set_hash_algorithm(&mut self, hash_algorithm: Option<HashAlgorithm>)

Sets the hash algorithm

Auto Trait Implementations§

§

impl Freeze for Engine

§

impl !RefUnwindSafe for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl !UnwindSafe for Engine

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<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> Upcastable for T
where T: Any + Send + Sync + 'static,

Source§

fn upcast_any_ref(&self) -> &(dyn Any + 'static)

upcast ref
Source§

fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)

upcast mut ref
Source§

fn upcast_any_box(self: Box<T>) -> Box<dyn Any>

upcast boxed dyn
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more